DEV Community

Cover image for ๐Ÿ“œ API Documentation release automation with Github, redocly and Open API ๐Ÿฆพ
adriens for opt-nc

Posted on • Updated on

๐Ÿ“œ API Documentation release automation with Github, redocly and Open API ๐Ÿฆพ

๐Ÿ’ก 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 :

Image description

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 :

โ˜๏ธ 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 ๐Ÿ‘‡

๐Ÿ”– Related contents

Top comments (7)

Collapse
 
adriens profile image
adriens

Image description

Collapse
 
adriens profile image
adriens

Collapse
 
adriens profile image
adriens

Collapse
 
adriens profile image
adriens

Collapse
 
adriens profile image
adriens
Collapse
 
adriens profile image
adriens
Collapse
 
adriens profile image
adriens