API registry service is a Python-based open source tool for managing and browsing OpenAPI YAML specifications and Swagger UI documentation.
·
Report Bug
·
Request Feature
- About The Project
- Built with
- Getting Started
- Usage
- Roadmap
- Contributing
- License
- Contact
- Acknowledgments
This open source project is a simple API registry service created with Python. It was built to provide an easy and convenient way to manage and browse OpenAPI YAML specifications and Swagger UI documentation.
The project is currently in its MVP (minimum viable product) stage, and is designed to be a basic starting point for building a more robust API registry system. It allows users to upload zip-archive files containing OpenAPI YAML specifications, and provides a simple user interface for browsing and accessing available APIs.
The project was inspired by the need for a lightweight and easy-to-use API registry service that could be easily customized and extended. It was built with Python and uses the FastAPI web framework, and Swagger UI for documentation.
We welcome contributions from the community to help improve and expand the functionality of the project. Please feel free to submit issues, pull requests, or feature requests on the project's GitHub repository.
Before running the app, you should have the following installed on your system:
- Docker - You can download and install Docker from here.
To run the app in a Docker container follow these steps:
-
Open a terminal or command prompt.
-
Pull the latest version of the
capcom6/api-registryDocker image:docker pull capcom6/api-registry:latest -
Start the app in a Docker container, exposing port 8000:
docker run -p 8000:8000 capcom6/api-registry:latest -
Open a web browser and navigate to
http://localhost:8000to access the app.
That's it! You should now be able to access the app in your web browser at http://localhost:8000. If you encounter any issues, please refer to the project's documentation or open an issue on the project's GitHub repository.
When you start the server, it listens for incoming requests on port 8000 by default. When you upload a zip-archive containing OpenAPI YAML specifications, the service expects the zip-archive to contain a folder for each project, with the OpenAPI spec in YAML format located in the project folder. The service extracts the files and stores them in a local directory. The service then reads the contents of the OpenAPI YAML files and generates Swagger UI documentation for each API.
The user interface provides a list of available APIs, and allows you to view the Swagger UI documentation for each API by clicking on the API name.
This app is designed to work out of the box without any additional configuration.
The API registry service does not include any built-in authorization or authentication mechanism. To enhance security, it is recommended to use an external service or tool, such as Nginx, to provide basic authentication and restrict access to the application. Alternatively, deploying the application in a private network can provide an additional layer of security and help prevent unauthorized access from external sources.
To help users get started with basic authentication using Nginx, a sample Docker Compose file is provided. This file includes a configuration for an Nginx reverse proxy that provides basic authentication for the API registry service. To use this configuration, you will need to modify the htpasswd file to include your own username and password.
Note that this configuration is only intended as a starting point, and may need to be customized or extended to meet the specific security needs of your application. It is recommended to consult with a security expert or follow industry best practices when implementing security measures for your application.
- Uploading a new zip-archive will overwrite any previously uploaded API specifications
- Parsing metadata from OpenAPI specs and displaying it in the user interface.
- Adding support for simple search functionality based on metadata fields.
- Enhancing support for uploading and managing multiple versions of an API.
- Integrating with other API management tools and services to provide a more comprehensive solution for API management.
- Improving the user interface and user experience, including customization options and branding support.
We welcome feedback and suggestions from the community to help shape the future roadmap of the API registry service. Please feel free to share your thoughts or ideas by opening issues or submitting pull requests on the project's GitHub repository.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the Apache-2.0 license. See LICENSE.txt for more information.
Project Link: https://github.com/capcom6/api-registry
We would like to thank the following individuals and organizations for their contribution to the development of the API registry service:
- The creators and maintainers of FastAPI, which form the backbone of the API registry service.
- The contributors to the OpenAPI Specification, which provides a common standard for describing RESTful APIs.
- The developers of the Swagger UI library, which provides a user-friendly interface for browsing and testing API endpoints.
Finally, we would like to thank our users and contributors for their valuable feedback and support. We are committed to continuing to improve and extend the API registry service, and look forward to working with the community to make it a more comprehensive and powerful tool for API management.