Have you ever heard of Open API Specification (Swagger)?
And if so how are you using it?
At my current company we spec out every API change as an Open API specification, store it as a swagger.yml file in the repo that the API code lives in and do many things with it including:
- Publish mocks to https://servicemocks.com from our Circle CI build pipelines
- Ingest the swagger.yml file at run time and use the request schemas to validate API requests made to the actual service.
- Publish docs to Service Mocks as well.
- Run contract validation tests in our builds using the swagger.yml file as an input
Curious what you are using O.A.S. (swagger) for. Anybody?
Can you dumb it down for everyone to understand, not everyone is a techy im afraid!
My apologies. This may have been better suited for the dev group.
Open API is a yaml/json specification that lets you describe what endpoints your API has and what requests/responses those endpoints accept and return.
Think of it as a API documentation format used by developers. It’s made it possible to auto generate code, documentation, mocks and tests.
I’m curious if others are using it in their API development process