saasify-to-openapi

1.20.0 • Public • Published

Saasify Logo

saasify-to-openapi

Converts Saasify deployments to OpenAPI specs.

NPM Build Status JavaScript Style Guide

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

/saasify-to-openapi/

    Package Sidebar

    Install

    npm i saasify-to-openapi

    Weekly Downloads

    27

    Version

    1.20.0

    License

    MIT

    Unpacked Size

    486 kB

    Total Files

    20

    Last publish

    Collaborators

    • chrisvxd
    • fisch0920