OpenAPI / Swagger to aspida

Convert OpenAPI 3.0 and Swagger 2.0 definitions into aspida.

Breaking change :warning:

$3

Since openapi2aspida >= 0.18.0 , decision whether to be required follows the OpenAPI spec correctly. Dropping the support for original implementation, that was defaulting to required.

$3

Since openapi2aspida >= 0.16.0 , requires TypeSciprt 3.8 or higher for Type-Only Imports.

$3

Since openapi2aspida >= 0.14.0 , request headers are forced to be optional.

$3

Since openapi2aspida >= 0.13.0 , optional for aspida only if the 'required' property of OpenAPI is set to false.

Getting Started

Compatible with yaml/json of OpenAPI3.0/Swagger2.0

``sh
$ mkdir petstore-api
$ cd petstore-api
$ npx openapi2aspida -i https://petstore.swagger.io/v2/swagger.json # or ../local-swagger.yaml


api/$api.ts was built successfully.

$ npm init -y
$ npm install @aspida/axios axios typescript ts-node @types/node
`

index.ts
`ts
import axiosClient from '@aspida/axios'
import api from "./api/$api"
import type { Pet } from './api/@types'

;(async () => {
const client = api(axiosClient())
const petId = 100
const body: Pet = {
id: petId,
name: 'hoge',
photoUrls: [],
status: 'available'
}

await client.pet.$post({ body })
const pet = await client.pet._petId(petId).$get()
console.log(pet)
})()
`

package.json
`json
{
"scripts": {
"start": "ts-node index.ts"
}
}
`

`sh
$ npm start


{ id: 100, name: 'hoge', photoUrls: [], tags: [], status: 'available' }


`

Build from config file

Create config file in project root

aspida.config.js

`js
module.exports = {
input: "api", // "input" of aspida is "output" for openapi2aspida
outputEachDir: true, // Generate $api.ts in each endpoint directory
openapi: { inputFile: "https://petstore.swagger.io/v2/swagger.json" }
}
`

`sh
$ npx openapi2aspida
`


Cli options

$3

path to an OpenAPI spec file for input

$3

can change aspida output directory

$3

path to an aspida config file

$3

displays version of openapi2aspida

$3

`bash
npx openapi2aspida -i=openApi/sample.yaml -o=lib/api/sample
``

License

openapi2aspida is licensed under a MIT License.