Skip to content

Commit 4380b7a

Browse files
committed
docs(readme): 📝 Expand introduction and usage
1 parent d4fe291 commit 4380b7a

1 file changed

Lines changed: 24 additions & 6 deletions

File tree

README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,30 @@
11
# openapi-tools
22

3-
A CLI tool to work with OpenAPI specifications, including generation, validation, and more.
3+
**openapi-tools** is a small toolbox for slicing, validating and generating code from OpenAPI specifications. It ships as a command line utility so you can keep your API definitions tidy and reusable.
44

5-
## Usage Example
5+
## Features
66

7-
Below is a quick example using the OpenAPI Pet Store:
7+
- **Filter paths** – create a minimal spec containing only the operations you care about.
8+
- **Generate Zod schemas** – produce TypeScript models ready for runtime validation.
9+
- **Generate Python `TypedDicts`** – build strongly typed models for Python projects.
10+
11+
## Installation
12+
13+
Use `npx` for one-off runs or install globally:
814

915
```bash
10-
npx @ai-foundry/openapi-tools filter --input openapi.yaml --output filtered.yaml --select-paths "/pet/{petId}"
16+
npm install -g @ai-foundry/openapi-tools
1117
```
1218

13-
### Using with Docker
19+
The examples below use the OpenAPI Pet Store specification. More scenarios are available in the [examples directory](examples/README.md).
20+
21+
### Quick Start
22+
23+
```bash
24+
npx @ai-foundry/openapi-tools filter --input openapi.yaml --output filtered.yaml --select-paths "/pet/{petId}"
25+
```
1426

15-
You can also use the tool via Docker:
27+
### Using Docker
1628

1729
```bash
1830
docker run --rm -v $(pwd)/local-schemas:/app/schemas adrianhdezm/openapi-tools filter --input ./schemas/openapi.yaml --output ./schemas/filtered.yaml --select-paths "/pet/{petId}"
@@ -81,6 +93,12 @@ Options:
8193
-h, --help display help for command
8294
```
8395

96+
## Contributing
97+
98+
1. Clone this repository and run `npm install`.
99+
2. Make your changes and add tests if applicable.
100+
3. Open a pull request – we welcome improvements and new features!
101+
84102
## License
85103

86104
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)