Bytechaser

Swagger

Swagger has been around for sometime now although it’s being superseded with the OpenAPI Specification (OAS). Essentially swagger is a specification that helps you document your API. Not only does swagger enable you to generate a clear online documented UI for your api (http://petstore.swagger.io/) it also provides middleware to validate incoming data.

Schemas are written in Yaml or Json and can be written as one large document or broken up into multiple files describing each endpoint.

It is possible to have swagger automatically generate the controller endpoints in node however I’ve found this to be impractical and restrictive, instead it easier to define your own controllers.

Initially it can be a pain debugging the errors however there are tools online to help you, and once you become familiar with the specification most bugs end up just being typos that are easy to fix.

If your interested in help designing or documenting an api then please get in contact.

Useful Resources

Do you have an app/project you'd like a quote for?

Hi there, I’m Alex and I’d love to discuss your next project with you.

I’m happy to discuss requirements, timeline, budget and any other concerns you may have.