@aqzhyi/openapi

[!NOTE]

A type-safe instance builder for RESTful API services, respecting swagger.json and following openapi

• [x] 🔋 type-safe and schema for RESTful API services and its instance.
• [ ] 🔋 type-safe react-hooks. (alternative openapi-react-query, swr-openapi)
• [ ] 🔋 some built-in middlewares. e.g. jwtMiddleware

Installation

pnpm add @aqzhyi/openapi -D

Configuration

1. create a file named openapi.config.ts in your project folder:

   import { build } from '@aqzhyi/openapi'
   
   build({
     services: [
       {
         name: 'myApiService',
         baseUrl: 'https://api.example.com/v1',
         swaggerUrl: '/openapi/swagger.json', // optional
         outDir: './app/services',
       },
     ],
   })

2. run the script in your terminal.

   pnpx tsx openapi.config.ts

   • will create './app/services/myApiService/index.ts'
   • will export myApiService as type-safe instance

Debug

DEBUG=openapi:* pnpx tsx openapi.config.ts

Usage

[!TIP]

for more details, see openapi-fetch

import { myApiService, Schemas, Paths } from './app/services/myApiService'

myApiService.GET('/search', {
  params: {
    query: {
      limit: 10,
    },
  },
})