saasify-openapi-utils
OpenAPI utilities for Saasify.
Install
npm install --save saasify-openapi-utils
API
Table of Contents
- annotate-openapi
- process-readme
- convert-openapi-to-services
- parse-openapi
- openapi-service-params-to-json-schema
- service-to-path-item
- path-to-service
annotate-openapi
Annotates a valid OpenAPI spec with extra metadata specific to Saasify's SaaS web client and Redoc.
Type: function (spec, deployment, opts): Promise
spec
object OpenAPI spec.deployment
object Parent Saasify deployment.opts
object? Optional config. (optional, default{}
)
process-readme
Pre-processes a markdown readme for display in Saasify's Redoc docs.
Type: function (rawReadme): string
rawReadme
string Raw markdown readme string.
convert-openapi-to-services
Converts an OpenAPI spec to Saasify's Service
format.
Type: function (openapi, config): Promise
parse-openapi
Validates and parses an OpenAPI spec according to Saasify's constraints.
Returns a potentially updated, deep cloned spec that should be used.
Type: function (spec): Promise
spec
object OpenAPI spec.
openapi-service-params-to-json-schema
Converts an OpenAPI-based Service's input parameters into a corresponding JSON Schema.
Type: function (service, openapi): Promise
service-to-path-item
Finds the OpenAPI PathItem that corresponds to a particular service.
Type: function (service, openapi)
service
openapi
path-to-service
Finds the service that corresponds with a particular relative URL path.
Type: function (path, deployment)
path
deployment
Related
- saasify - Saasify is the easiest way to launch your own SaaS.
License
MIT © Saasify