openapi-devtools

Fixes

Addresses https://github.com/AndrewWalsh/openapi-devtools/issues/15.

Key names of securitySchemes now follow the expected regex standard, excluding whitespace.

Now Available for Firefox

• Thanks to @madeindjs' PR this is now available for Firefox.

General

• Minor copy edit to generated API specs.

Fixes

• The tool now handles multiple response status codes. Endpoints can return multiple responses for different status codes, such as 200s and 400s. These are now merged correctly, and will appear when endpoints containing multiple response status codes are parameterised.

General

• As the underlying data structure has changed, exports will no longer work when imported with v1.5.0. Please create a new one if affected
• Added tests and improved some code.

fix: media types such as application/x-www-form-urlencoded may have a suffix, such as application/x-www-form-urlencoded;charset=UTF-8. These requests are now accounted for across application/json and application/x-www-form-urlencoded;charset=UTF-8.
chore: reverted addition of external spec generation library. It will exist elsewhere in the near future

chore: use new npm package for spec generation

feat: now supports application/x-www-form-urlencoded mime types in requests https://news.ycombinator.com/item?id=38012032#38012843
fix: fixed an issue with parameterisation related to https://github.com/unjs/radix3/pull/73
general: the algorithm is now able to support multiple mime types
general: added more tests against core logic
general: increased the length of truncated paths
general: completely decoupled the core algorithm from Chrome. It now uses the standardised @types/har-format

• fix: there was an issue with the way the dist.zip file was zipped & v1.3.0 is broken. This is the fix

• feat: api keys in auth headers are now parsed and will be associated with endpoints
• feat: api keys in cookies are also parsed, keys that look like they relate to auth will be associated with endpoints
• feat: new Actions menu that presents opportunities to users. Currently includes guidance on how to use the app to generate code for 20+ languages easily. This can be achieved by pasting generated schemas into https://app.quicktype.io/
• feat: long parts in pathnames are now truncated in the middle. Hovering on the part shows a tooltip of the full name. This should resolve UI issues with long pathnames
• fix: the import modal is now cleared after import
• general: code cleanup in some areas, and added comments to clarify core types that power the algorithm
• general: improved some tooltips & clarity in text content

• Refactored authentication in preparation for later work

• Fixed parameterisation after import

• Add new option More Info. When enabled, the app will use the most recent request and most recent response as examples.
• Add Import/Export feature. You can now export the app state to a string, and import it at any time to load a session. This also means that sessions can be shared.
• Fixed an issue with parameterising encoded paths.

• @debakarr 's fix to ensure that we validate the JSON response, and not just rely on the mime type. In practice, this will catch some edge cases
• Endpoints will now show basic auth
• Endpoints will now show digest auth
• There's more work to be done on the auth front. I took a look at har-to-openapi & it's clear that there are more opportunities to surface API keys and other important info. Next steps are to extract as much info from HTTP auth headers & cookies as possible.
• Simplified HTTP auth derivation

• The app now ignores many default uninteresting request and response headers
• Fixed a bug affecting path parameters that could happen when parameterising similar paths
• Add support for determining auth from HTTP authorization headers. So far, Bearer auth has been implemented

• Fix: cannot parameterise when a longer path exists, such as /1/2<- when /1/2/... exists
• Path parameters are always required
• Readme additions
• Setup GitHub releases

The initial release of the tool.