maira-cli
swagger documentation
Listed in categories:
Developer ToolsAPIOpen Source
Description
MairaCLI is a developer tool designed to automatically generate Swagger documentation for API endpoints by intercepting requests and responses during testing.
How to use maira-cli?
To use MairaCLI, install it via npm, start the proxy server within your backend project, configure the necessary details in the config.json file, and make requests to your backend through the proxy server. After making requests, generate the documentation using the provided command.
Core features of maira-cli:
1️⃣
Automatically generates Swagger documentation for API endpoints
2️⃣
Intercepts requests and responses for accurate documentation
3️⃣
Creates configuration files for project routes
4️⃣
Generates documentation preview links
5️⃣
Supports custom authentication headers
Why could be used maira-cli?
| # | Use case | Status | |
|---|---|---|---|
| # 1 | Generating API documentation for backend projects | ✅ | |
| # 2 | Testing API endpoints while documenting them | ✅ | |
| # 3 | Creating Swagger documentation for microservices | ✅ | |
Who developed maira-cli?
MairaCLI is developed by a community of contributors on GitHub, aimed at simplifying the process of API documentation for developers.