saasify-openapi-utils
OpenAPI utilities for Saasify.
Last updated a month ago by fisch0920 .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install saasify-openapi-utils 
SYNC missed versions from official npm registry.

Saasify Logo

saasify-openapi-utils

OpenAPI utilities for Saasify.

NPM Build Status JavaScript Style Guide

Install

npm install --save saasify-openapi-utils

API

Table of Contents

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

  • openapi object OpenAPI spec.
  • config object Parsed Saasify project configuration.

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


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 object Service to convert.
  • openapi object OpenAPI spec for the parent deployment.

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

Current Tags

  • 1.20.8                                ...           latest (a month ago)

32 Versions

  • 1.20.8                                ...           a month ago
  • 1.20.3                                ...           2 months ago
  • 1.20.1                                ...           2 months ago
  • 1.20.0                                ...           2 months ago
  • 1.18.30                                ...           4 months ago
  • 1.18.28                                ...           4 months ago
  • 1.18.25                                ...           4 months ago
  • 1.18.13                                ...           4 months ago
  • 1.18.6                                ...           4 months ago
  • 1.18.5                                ...           4 months ago
  • 1.18.4                                ...           4 months ago
  • 1.18.3                                ...           4 months ago
  • 1.17.13                                ...           4 months ago
  • 1.17.12                                ...           4 months ago
  • 1.17.11                                ...           4 months ago
  • 1.17.7                                ...           5 months ago
  • 1.16.8                                ...           5 months ago
  • 1.16.6                                ...           5 months ago
  • 1.16.5                                ...           5 months ago
  • 1.16.3                                ...           5 months ago
  • 1.16.2                                ...           5 months ago
  • 1.16.0                                ...           5 months ago
  • 1.15.9                                ...           6 months ago
  • 1.15.7                                ...           6 months ago
  • 1.15.6                                ...           6 months ago
  • 1.15.5                                ...           6 months ago
  • 1.15.4                                ...           6 months ago
  • 1.15.3                                ...           6 months ago
  • 1.15.2                                ...           6 months ago
  • 1.15.1                                ...           6 months ago
  • 1.15.0                                ...           6 months ago
  • 1.14.0                                ...           6 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 1
Last Month 40
Dev Dependencies (3)
Dependents (2)

Copyright 2014 - 2016 © taobao.org |