saasify-to-openapi

Converts Saasify deployments to OpenAPI specs.

Install

npm install --save saasify-to-openapi

Usage

const convertSaasifyToOpenAPI = require('saasify-to-openapi')
const deployment = { /* ... */ }

const openAPI = await convertSaasifyToOpenAPI(deployment)

Examples

See the test fixtures and their corresponding output snapshots for conversion examples.

TODO

Should any of these be injected by the saas client?

• [ ] info.x-logo
• [ ] info.termsOfService
• [ ] info.contact
• [ ] info.license (look into licensing options)
• [ ] info.description
• [ ] tags
• [ ] update correct path routes
• [ ] operation.security
• [ ] apiKey => API Key
• [ ] update security section
• [ ] add GET path

Related

• saasify - Saasify is the easiest way to launch your own SaaS.
• fts - TypeScript standard for rock solid serverless functions.
• OpenAPI - API specification.

License

MIT © Saasify