github-action
generator
Our great sponsors
github-action | generator | |
---|---|---|
6 | 5 | |
38 | 728 | |
- | 7.4% | |
7.0 | 8.9 | |
4 days ago | 8 days ago | |
TypeScript | JavaScript | |
MIT License | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
github-action
-
An AsyncAPI Example: Building Your First Event-driven API
Letโs walk through the process of implementing an event-driven API using AsyncAPI, a specification for defining asynchronous APIs. Weโll also introduce Bump.sh, a tool for documenting and tracking event-driven APIs lifecycle/changes, and demonstrate how you can use it in conjunction with AsyncAPI files.
-
The Best API Documentation Tools for Dev Teams in 2023
Bump.sh is a tool that's swiftly gaining popularity as it combines many of the best features from the previous five entries in this roundup.
-
API Diff - Compare in seconds two versions of
your API
With Bump, you can easily track changes within your API documentation, between different versions. We wanted to give a glimpse of the magic behind Bump, with a tool that could compare two versions of an API: API Diff.
-
What is AsyncAPI?
Bump.sh ๐
-
Swagger/OpenApi Documentation in ktor
๐ Fernando, We are providing an API documentation generation tool at Bump, based on the OpenAPI specification. Feel free to give it a look and reach out to me if you need, I'd be happy to help :).
-
Bump diff, the missing piece for an API โdesign-firstโ approach
If you use Github Actions to launch your automation workflows, we have some more good news for you: we now offer a stable bump-sh/github-action@v1 action. And this release includes automatic API contract changelog pushed as a comment for each pull request.
generator
-
AsyncAPI Codegen, a code generator from AsyncAPI spec v2 and v3.
For that, the project provides a Javascript tool to generate source code from specification in numerous languages: Python, Java, Markdown, PHP, โฆ and even Go! All you have to do is install the corresponding NPM packages and launch the right command tool.
-
What is AsyncAPI?
AsyncAPI Generator
-
An introduction to the AsyncAPI specification
With the file created, we can now generate more friendly documentation. For this, we need to install generator or use it in its Docker version.
-
Getting Started with CloudEvents and AsyncAPI
This can be improved and extended overtime, especially because of the way the generator is designed, enabling extensibility so we can have templates for many other languages that support more protocols, etc. For example, there is only a NATS generator for .NET Core... but perhaps in the future there could be more protocols supported for .NET Core and examples built for Azure ๐.
-
How to contribute to OSS AsyncAPI Initiative ๐
Continue improvements and add new features to core tools such as our spec parser/validator and code generator.
What are some alternatives?
ReDoc - ๐ OpenAPI/Swagger-generated API Reference Documentation [Moved to: https://github.com/Redocly/redoc]
spec - CloudEvents Specification
spec - The AsyncAPI specification allows you to create machine-readable definitions of your asynchronous APIs.
asyncapi-to-postman - Creates a Postman collection from an AsyncAPI file.
API-Portal - API Portal lets you create and publish a customized site with API documentation, for free and without writing any code.
redoc - ๐ OpenAPI/Swagger-generated API Reference Documentation
parser-js - AsyncAPI parser for Javascript (browser-compatible too).
apiDoc - RESTful web API Documentation Generator.
cupid - A library that focuses on finding and analyzing the relationships between AsyncAPI documents. It outputs a map of the system architecture. Except for a default map, it is possible to get output as mermaid.js flow diagram, PlantUML class diagram and more to come.
OpenAPIValidators - Use Jest or Chai to assert that HTTP responses satisfy an OpenAPI spec
wg-serverless - CNCF Serverless WG