Skip to content

Latest commit

 

History

History
20 lines (14 loc) · 915 Bytes

quick-start.md

File metadata and controls

20 lines (14 loc) · 915 Bytes
Raw

Got 60 Seconds? Try me!

Copy the following command into your terminal. The only prerequisite is Node 16+.

npm i -g ts-node
npx counterfact@latest https://petstore3.swagger.io/api/v3/openapi.json api --open

What does that command do?

  1. installs the @latest version of counterfact
  2. reads an OpenAPI 3 document (https://petstore3.swagger.io/api/v3/openapi.json)
  3. generates TypeScript files in the api directory
  4. starts a server which implements the API
  5. opens your browser to Swagger UI (--open)

You can use Swagger to try out the auto-generated API. Out of the box, it returns random responses using metadata from the OpenAPI document. Edit the files under ./api/paths to add more realistic behavior. There's no need to restart the server.

To learn more, see the Usage Guide.