Rate My OpenAPI
At Zuplo we believe that the better the quality of an OpenAPI document, the better the developer experience will be for the consumers of that API. This experience is important for the success of an API.
Rate My OpenAPI is a suite of tools designed to help software developers using OpenAPI to meet high standards of quality and usability when designing and developing their APIs. Our tools include a website, a CLI, a GitHub Action and an API, all aimed at ensuring your APIs meet high standards of quality and usability.
Categories of Evaluation
Our tools evaluate your OpenAPI definition files and provide a comprehensive score based on four key categories:
- Documentation: Ensure your API is well-documented, making it easy for users to understand and use.
- SDK Generation: Verify that your API definition supports SDK generation, facilitating integration and usage in different programming languages.
- Security: Check for best practices and standards to ensure your API is secure and protected against common vulnerabilities.
- Completeness: Ensure your API definition is complete, with all necessary endpoints, parameters, and responses accurately defined.
Tools
Website
https://ratemyopenapi.com offers a user-friendly interface for developers to upload and analyze their OpenAPI definition files.
Key features include:
- Linting: Upload & lint your OpenAPI files to receive detailed feedback.
- Comprehensive Scoring: Get a clear, actionable score rating your API's documentation, SDK generation, security, and completeness.
- Detailed Reports: Access in-depth reports that highlight areas of improvement and provide recommendations.
- Visualization: Easily visualize the structure and quality of your API with in-line feedback.
CLI
The CLI tool is perfect for developers who prefer working from the command line or need to integrate quality checks into their development workflow.
Key features include:
- Automated Checks: Integrate the CLI into your CI/CD pipeline for automated quality checks on every commit.
- Detailed Output: Get detailed feedback directly in your terminal, with options to further integrate these results into your development flow.
GitHub Action
Our GitHub action seamlessly integrates with your repository to ensure your APIs are consistently of high quality. Key features include:
- Automated Linting: Automatically lint OpenAPI definition files on every pull request and push to ensure code quality.
- Inline Feedback: Receive feedback directly in your pull requests with comments highlighting issues and areas for improvement.
- Continuous Improvement: Maintain a high standard of API quality with continuous monitoring and feedback.
Overview video
Check out the Rate My OpenAPI overview video to see the CLI and GitHub Action in... umm, action.
