This repository contains the slides for a meet-up at Web Developer Chemnitz concerning API specification language essentials. It includes some API specification examples based on OpenAPI (f.k.a. Swagger), RAML and API Blueprint.
Use $ yarn install
to install all the necessary dependencies. Afterward you can serve the slides locally at
http://localhost:8000 via $ yarn start
.
- Spectacle will be used for the HTML docs based on the OpenAPI example:
$ yarn run openapi:docs
- RAML to HTML is the tool for the HTML docs based on the RAML example:
$ yarn run raml:docs
- aglio renders the HTML docs based on the API Blueprint example:
$ yarn run apib:docs
- Pokemock is a express based mock server for OpenAPI:
$ yarn run openapi:mocks
- Drakov API Blueprint Mock Server will start a mock server based on the API Blueprint example:
$ yarn run apib:mocks