Skip to content

Commit ead90c1

Browse files
committed
update readme
1 parent d9c4792 commit ead90c1

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
<ol>
4646
<li>
4747
<a href="#about-the-project">About The Project</a>
48+
<ul>
49+
<li>
50+
<a href="#features">Features</a>
51+
</li>
52+
</ul>
4853
</li>
4954
<li>
5055
<a href="#getting-started">Getting Started</a>
@@ -83,6 +88,16 @@ Demystify is a suite of tools designed to help understand API behaviour. It gene
8388

8489
It identifies path parameters automatically without manual intervention. Data in the generated specification reflects all observed information across multiple status codes and mime types for request and response headers, bodies, query parameters, path parameters, and cookies for each endpoint.
8590

91+
### Features
92+
93+
- Everything in [OpenAPI DevTools](https://github.com/AndrewWalsh/openapi-devtools)
94+
- Identifies [path parameters](https://www.abstractapi.com/guides/api-glossary/path-parameters) automatically
95+
- Is available as a desktop app that uses a proxy to generate specifications in real time (e.g. a real time version of [mitm2swagger](https://github.com/alufers/mitmproxy2swagger) that supports OpenAPI 3.1)
96+
- Has a website and command line tool that can generate OpenAPI specifications from HAR files (e.g. [har-to-openapi](https://github.com/jonluca/har-to-openapi) or [openapi-autospec](https://github.com/Adawg4/openapi-autospec))
97+
- Uses a published library that can generate API specifications for any API in middleware, DevOps integrations, or any environment
98+
- Can generate curl commands, client code, and send API requests via an API client that populates automatically via [Scalar](https://github.com/scalar/scalar)
99+
- Is agnostic to API semantics and may translate into different versions of OpenAPI, or reverse engineer other HTTP-based standards such as GraphQL
100+
86101

87102

88103
<p align="right">(<a href="#readme-top">back to top</a>)</p>

0 commit comments

Comments
 (0)