AppMap records all the HTTP API behavior in your application and automatically generates OpenAPI definitions. It works automatically in your code editor and in CI, keeping your definitions in sync with your code changes.
Keeping definitions in sync and up to date with the API's latest behavior is time consuming and error prone. AppMap generates an OpenAPI spec automatically in your code editor or in CI. Save time writing documentation and get back to the development work you love.
OpenAPI definitions generated by AppMap can be used for anything you would do as part of your normal workflow, including loading into tools like Postman, or readme.com.
Once AppMap's OpenAPI Generator has been integrated into your CI system, you can use it within your code review workflow to see the API behavior differences caused by each code change.
AppMap allows developers to move to an API-first mode in almost no time. By creating OpenAPI definitions and updating them automatically in Postman, teams using AppMap can leverage all the valuable features in the Postman API Platform. Read the full blog post on the Postman site.
A real world example of keeping API documentation up to date by automating OpenAPI generation, includes the command for running AppMap OpenAPI generation from CI. Read the full blog post on dev.to.
Install the AppMap extension for your Visual Studio Code or JetBrains Code editor, record AppMap Data, and start generating OpenAPI definitions.
With AppMap your source code and data never have to leave your local development environment. Many new developer tools require you to upload source code and grant privileges to your repo, but AppMap does not. This is by design.
If you have any questions about how this is done, or would like an AppMap developer to help you get up and running, feel free to drop into our Slack, introduce yourself, and ping us!
Get AppMap