adriens💡 Inception
I truly ❤️ the way Forem manages its community by providing ready to use resources to help make things possible.
Their way of achieving documentation really impressed me, see by yourself :
So I wanted to offer the same comfort to the users of the APIs we create & maintain
👉 This post is about how we achieved that as part of our maintenance & release process.
❔ Intro
Pretty often, people ask you for API documentation. Most of the time you have a live and running Swagger interface (aka. Swagger UI), but..
when you have onPrem APIs, some people may not have access to an up-to-date documentation.
This post will show how we did achieve this on one of our APIs : domaine-nc-api.
📝 Ways of releasing documentation
Below are some ways to achieve and access documentation :
- Live & running Swagger instance
- Swagger from running Docker (public images) instance, see
optnc/domaine-nc-api - API Marketplace like our API Marketplace on RapidAPI
- Static openAPI
yamlexports - Static web documentation (achieved thanks to redocly)
☝️ To achieve all this work, we are using Continuous Integrations, with GitHub Action so the job is done as part of the release process.
🍿 Démo
With the following demo you'll discover live how we achieve the whole maintenance & release process to achieve all these tasks 👇
