Skip to content
Project in development - Open sourced service overlay for SDK management using swagger-codegen
Branch: development
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.storybook
.vscode
__mocks__
build-packages/build-util
docs/contrib
packages
scripts
test/snapshots
.gitignore
.prettierignore
.travis.yml
CONTRIBUTING.md
DEVELOPMENT.md
Gulpfile.js
LICENSE
README.md
babel.config.js
jest.config.js
lerna.json
package.json
prettier.config.js
tsconfig.json
tslint.json
yarn.lock

README.md

openapi-platform

Project in development - Open sourced service overlay for SDK management using swagger-codegen

Minimum Requirements

  • Node 8.x
  • PostgreSQL

Installation

npm install --global @openapi-platform/frontend @openapi-platform/server

or

yarn add global @openapi-platform/frontend @openapi-platform/server

How to use it

  1. Run start-openapi-platform-server
  2. Run start-openapi-platform-frontend

Pushing SDKs to Git repositories

You'll need to generate personal access token (see GitHub, GitLab and BitBucket) that has permissions to clone and push the git repository that you want to push the SDK to.

Note that, at the moment, you'll need to intialise the Git repository before OpenAPI Platform can make commits to it.

Configuration

You can create a config file in your current working directory called openapi-platform.config.xxx where xxx is a json, yaml or json5. For more detailed information about configuration, you can check the node-convict schema file.

You can’t perform that action at this time.