The main repository is hosted in gitlab.com/ravimosharksas but it is automatically mirrored to github.com/RavimoShark, github.com/singletonsd, github.com/patoperpetua, gitlab.com/singletonsd and to gitlab.com/patoperpetua, github.com/patoperpetua. If you are in the Github page it may occur that is not updated to the last version.
Swagger documentation of global API. See HTML documentation in https://ravimosharksas.gitlab.io/apis/piece/documentation
- Starts the development server:
npm start - Bundles the spec and prepares web_deploy folder with static assets:
npm run build - Validates the spec:
npm test - Deploys docs to GitHub Pages:
npm run gh-pages - Run swagger-repo scripts locally:
npm run swagger-repo - Run create-openapi-repo scripts locally:
npm run create-openapi-repo
You can create the following folders here:
schemas- reusable Schema Objectsresponses- reusable Response Objectsparameters- reusable Parameter Objectsexamples- reusable Example Objectsheaders- reusable Header ObjectsrequestBodies- reusable Request Body Objectslinks- reusable Link Objectscallbacks- reusable Callback ObjectssecuritySchemes- reusable Security Scheme Objects
- Reference Documentation (ReDoc)
- OpenAPI Raw Files: JSON YAML
Contributions to this repository are very welcome.
To contribute, please fork this repository on GitLab and send a pull request with a clear description of your changes. If appropriate, please ensure that the user documentation in this README is updated.
If you have submitted a PR and not received any feedback for a while, feel free to ping me on Twitter or find me on facebook
- Config tool to generate models diagram.
- Config client libraries on commit.
- Upload html documentation to gitlab pages.
- Upload html documentation to servers.
- Use scripts from remote repository.
- Gitlab ci-cd template from remote repository.
- Split swagger.yaml into multiple files.
- Use ReDoc documentation framework.
© Singleton SD, France, 2019.