Thanks to visit codestin.com
Credit goes to GitHub.com

Skip to content

Managing REST documentation the easy way.

License

Notifications You must be signed in to change notification settings

vvalchev/api-hub

Repository files navigation

What api-hub does?

api-hub is very simple repository for storing, serving and invoking REST API.

The project is designed to solve the following problems:

  • There is a small-to-mid-size project designed using Micro-Services that communicates via REST and documented using Swagger / OpenAPI.
  • As developer I want to have the documentation of all services in a single place, where I can find them easily.
  • A DevOps must be able to configure the pipelines easily to upload the API specification on build.
  • DevOps must be able to deploy the application easily in the cloud or any other machine, that supports Docker.
  • As developer, I would like to be able to invoke some API manually and Swagger-UI and/or Redoc is enough.

What api-hub does not do?

Alternatives

Speaking of visualisation and documenting the REST API, the following alternatives has also been considered, but not implemented:

This project looks a lot like APIs.guru. It is a great tool, if you want to publish your API publicly.

What more can be done?

Automatic code samples generation for Redoc. There are tools, that can generate some code snippets, but apparently, they are not build into Redoc. Using those tools the published specification may be updated with some code examples:

Metrics is something else that is worth adding. It might be useful to know which API are used/browsed/downloaded most.

CORS Proxy like cors-anywhere.

About

Managing REST documentation the easy way.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages