title: API π for π & π€ author: name: I'm Adrien, I π€ API, a.k.a API lead π€ email: a.gibrat@oodrive.com theme: ./theme controls: false output: index.html
--
-- screen full
--
- Keep the API design process simple & enjoyable
- Get all the possible value from OpenAPI specs (OAS)
- Ensure rest API common practice and quality
-- screen
-- screen
Backend only write API doc π![API doc in code](https://raw.githubusercontent.com/adriengibrat/APItools.md/master/img/write_code.gif)
![API doc in code](https://raw.githubusercontent.com/adriengibrat/APItools.md/master/img/api_doc_in_code.jpg)
![API doc in code](https://raw.githubusercontent.com/adriengibrat/APItools.md/master/img/unexpected_effect.gif)
-- screen
- You'll need a good editor
- Be sure to write good spec
- Deliver Mocks & Docs
--
Swagger editor quick & dirty online editor
Openapi extension or
Swagger plugin or
KaiZen editor IDE integration
Stoplight studio advanced specification suite
-- screen large
--
You can start from scrath or migrate to openAPI Specification!
[![Transformer can translate lots of API specifications into OpenAPI](img/transformer.gif)](https://www.apimatic.io/transformer/ "Transformer works great but automatic transform eventually require manual tuning") [Swagger, RAML, Blueprint & Postman to OpenAPI](https://www.apimatic.io/transformer/#supported-formats)[![JSON sample to OpenAPI schema](img/json_oas_schema.jpg)](https://swagger-toolbox.firebaseapp.com/ "JSON or OpenAPI schema are verbose") [JSON sample to OpenAPI](https://swagger-toolbox.firebaseapp.com/)
--
Ask and learn from the best
... no consumer yet!
Lint speccy
spectral lint openapi.yml
in &
Enforce common rules and standard practice
Detect changes openapi-diff
& make changelog
-- screen
```yaml include: oogit.oodrive.net/ci-templates/api-doc/open-api-run.yml ```--
- Swagger UI quick & easy documentation
- OpenAPI viewer clean & simple try out
- Redoc clear advanced documentation + Postman
-- screen large
--
- Displays data types & formats
- Supports named examples
- Practical x-extension & plugins: tags, side-menu, code samples ...
- Futur version Β©οΈ may add try out, already a pro feature
Nah, really... just use Postman ;)
-- screen fullscreen
--
Fake auto-generated API allows you to
- Play with API from a simple spec file, even at the MR stage
- Start to implement client services & views upfront
- Collect feedbacks from customers / external partners
HTTP Mock server apisprout
prism mock openapi.yml
again
-- screen
--
- Validate request payload & params, send 400 otherwise
- Validate servers (request passthrough)
- Magic query params
?__example=myStuff&__code=404&__server=prod
- Generate realistic fake data using
x-faker
(vendor extention)
-- screen
--
- Auto deploy Mock servers?
- Add internal API docs & tryout on API management Gravitee!
- Continue to support teams adopting design first with OpenAPI...
- Stay tuned with Louis Lin ;)