Introduction

What is apydox?

Apydox is a portal for providing documentation for services that provide REST API interfaces. Apydox is a management layer on top of the excellent Swagger Editor and Swagger UI tools for editing and viewing api documentation in a single place.

What is its purpose?

You may ask, with services like SwaggerHub for managing your api documentation across your teams available why on earth would the world need apydox?

Apydox is an open source alternative that is free to use, modify and deploy in your preferred environment. Apydox allows smaller teams to save on costs and provide a single source of truth and version control for your api documentation needs. The portal makes use of Github for authentication, authorisation and storing and organising your api specifications.

For larger teams the benefit comes with being able to easily track and have any amount of users each accessing the portal and making modifications with their Github account. This makes collaboration, versioning and visibility on user contributions very easy and inexpensive. With services like SwaggerHub it can get very expensive for teams of 10 or more.

To summarise, apydox provides a single place for you to your manage your api documentation making use of the powerful Swagger Editor, removing the inefficiencies and inconsistencies in passing around api documentation that is often not standardised or version controlled.

How to get started

Apydox is full-stack web application with an API and a web UI, you can deploy it using docker containers or as a set of serverless functions and an S3 bucket for the UI. Check out the deployment section to learn how you can deploy the portal in whichever way you prefer.