Containerizing Your API Documentation,

I’ve used Swagger for a while now, and the online editor is not any stranger to me. Nevertheless it acquired me pondering, is there a approach to transfer the modifying to a neighborhood setting, on condition that there is no such thing as a assure that the online editor can be up always. For a enterprise group, it made sense to decouple this portion of the workflow and make it accessible to builders’ native environments.

Thankfully, containerizing the native growth setting shouldn’t be a international idea, particularly lately. Docker has been and nonetheless is a extremely popular containerization software. It appeared potential to run it like an online utility, utilizing a file watcher and modifying the code dwell to develop the applying regionally.

And so it was done!

Within the above, I added a working docker-compose.yml for this containerization course of. Two essential particulars about this configuration:

Firstly, my present listing is to be mounted as a quantity on the container, in order that any updates could be mirrored instantly (actually vital after we need to take a look at native documentation modifications instantly).

Secondly, the Dockerfile relies on swaggerapi/swagger-ui , leveraging on the advantages that this base picture already has — corresponding to not having to construct the HTML and JS belongings once more. This was additionally chosen to be accomplished right here, to be sure that the native growth course of solely must deal with the core swagger configuration, and the CICD course of would even be less complicated and sooner for a similar motive.

For deployment, my objectives have been clear — to have the ability to create a docker picture that may be deployed anyplace. This may help each personal and public documentation, whereby personal photographs can be used for internet hosting containers in personal networks, and likewise for public photographs.

Constructing the Docker picture is an easy course of because the base Docker image is already created for native use. The precise directions to construct this picture is as seen in my venture’s readme:

From this level, you’ll simply have to push this similar picture to your personal picture registry and host your utility utilizing this picture. I’d closely advocate utilizing serverless platforms corresponding to Google Cloud’s Cloud Run which makes use of these photographs for deployment, although you may also use it in your personal Kubernetes Clusters or VMs.

Leave a Reply

Your email address will not be published. Required fields are marked *

%d bloggers like this: