Add AppMap Automated OpenAPI Generator

[petecheslock]

You can use AppMap to auto-generate your OpenAPI documentation based on the runtime behavior of the code. Simply add AppMap to your project as a library dependency and either run your API tests or interact with your APIs to generate AppMaps then export this data into OpenAPI format.

[daveshanley]

This does not look like an OpenAPI tool.

The description in the repo is:

This repository is home to a variety of AppLand JavaScript/TypeScript projects. Many of our projects are standalone but depend on one another, meaning code changes can often span multiple projects. This monorepo serves to simplify the code review and publishing process across all of these projects.

It may contain OpenAPI functionality, but it's not a tool focused on OpenAPI.

[darrelmiller]

@daveshanley It does appear like generating OpenAPI descriptions is only part of what the tooling does, but it does look like it is well maintained and has fairly decent docs about using it to generate OpenAPI descriptions https://appmap.io/docs/openapi

[AndrewWalsh]

@petecheslock Could you provide more information on the https://appmap.io/docs/guides/openapi.html process?

My understanding is that this is middleware that integrates with frameworks.

With regard to Object schema is inferred from runtime data. When there are many examples of a request, the inferred schema of all the examples is merged into one unified schema. - is this in-house or dispatching network requests from the middleware to a platform, then using something like https://www.npmjs.com/package/har-to-openapi ?

Overall I feel there are better ways to describe this product, how it relates to OpenAPI (I note it appears to, have read your docs), and be more descriptive in general.

While I am closing this PR, I do so encouraging a new one that addresses these factors and eliminates ambiguity for maintainers in terms of how this tool works, how its capabilities can be verified, and what opportunities it offers.

It's an interesting platform, but I don't feel this PR does it justice and I would greatly appreciate greater description in the next. Case in point, the description Use AppMap to auto-generate OpenAPI docs back on the runtime behavior of the code. is unclear, as this makes it sound like it analyses code structure and produces an OpenAPI spec from it. However, docs refer to HTTP analysis and network traces, an entirely different approach.

So to conclude, please do resubmit with more information just to help us determine where this fits in and how it pertains to the OpenAPI ecosystem :).