Skip to content

Commit 7b08c23

Browse files
committed
docs: simplify examples section
1 parent 94291ea commit 7b08c23

File tree

1 file changed

+5
-16
lines changed

1 file changed

+5
-16
lines changed

README.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -842,29 +842,18 @@ Custom schema files support YAML/JSON in OpenAPI 3.0 format. See **[next15-app-m
842842

843843
## Examples
844844

845-
This repository includes several complete example projects:
845+
Explore complete demo projects in the **[examples](./examples/)** directory, covering integrations with Zod, TypeScript, Drizzle and documentation tools like Scalar and Swagger.
846846

847-
### 📦 Available Examples
848-
849-
| Example | Description | Features |
850-
| --------------------------------------------------------------- | ----------------------- | ----------------------------------------------- |
851-
| **[next15-app-zod](./examples/next15-app-zod)** | Zod schemas example | Users, Products, Orders API with Zod validation |
852-
| **[next15-app-drizzle-zod](./examples/next15-app-drizzle-zod)** | Drizzle-Zod integration | Blog API with Drizzle ORM + drizzle-zod |
853-
| **[next15-app-mixed-schemas](./examples/next15-app-mixed-schemas)** 🆕 | Multiple schema types | Zod + TypeScript + Custom YAML schemas combined |
854-
| **[next15-app-typescript](./examples/next15-app-typescript)** | TypeScript types | API with pure TypeScript type definitions |
855-
| **[next15-app-scalar](./examples/next15-app-scalar)** | Scalar UI | Modern API documentation interface |
856-
| **[next15-app-swagger](./examples/next15-app-swagger)** | Swagger UI | Classic Swagger documentation |
857-
858-
### 🚀 Running Examples
847+
### 🚀 Run an Example
859848

860849
```bash
861-
cd examples/next15-app-drizzle-zod
850+
cd examples/next15-app-zod
862851
npm install
863-
npm run openapi:generate
852+
npx next-openapi-gen generate
864853
npm run dev
865854
```
866855

867-
Visit `http://localhost:3000/api-docs` to see the generated documentation.
856+
Then open `http://localhost:3000/api-docs` to view the generated docs.
868857

869858
## Available UI providers
870859

0 commit comments

Comments
 (0)