Skip to content

Commit

Permalink
fix the docs for quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
pmcelhaney committed Oct 2, 2024
1 parent ee0b3a2 commit dc0862d
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Copy the following command into your terminal. The only prerequisite is Node 16+.

```sh copy
npx counterfact@latest https://petstore3.swagger.io/api/v3/openapi.json api --open
npx counterfact@latest https://petstore3.swagger.io/api/v3/openapi.json api
```

## What does that command do?
Expand All @@ -12,8 +12,7 @@ npx counterfact@latest https://petstore3.swagger.io/api/v3/openapi.json api --op
2. reads an [OpenAPI 3](https://oai.github.io/Documentation/) 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](https://swagger.io/tools/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/routes` to add more realistic behavior. There's no need to restart the server.
You can use [Swagger UI](https://swagger.io/tools/swagger-ui/) 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/routes` to add more realistic behavior. There's no need to restart the server.

To learn more, see the [Usage Guide](./usage.md).

0 comments on commit dc0862d

Please sign in to comment.