Skip to content

Commit 2ecb320

Browse files
fix readme
1 parent 4731eaa commit 2ecb320

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

.github/workflows/version.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ jobs:
4949
cache: "pnpm"
5050

5151
- name: Version packages
52-
# Ignore exit code since this will fail from the workspace:* protocol for some reason
52+
# Ignore exit code since this will fail from the workspace:* protocol for some reason
5353
run: pnpm version ${{ github.event.inputs.version_type }} --no-git-tag-version --workspaces --include-workspace-root || true
5454

5555
- run: echo "PACKAGE_VERSION=$(jq -r .version package.json)" >> $GITHUB_ENV

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ npm install -D openapi-typescript openapi-typescript-server
3737
Install runtime adapter (Express example):
3838

3939
```bash
40-
npm install openapi-typescript-server-express
40+
npm install openapi-typescript-server-express openapi-typescript-server-runtime
4141
```
4242

4343
**Recommended**: Install middleware for runtime validation:

packages/openapi-typescript-server/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,19 @@ At runtime, your implementation is converted into HTTP handlers for various fram
3131
Install build-time packages as dev dependencies:
3232

3333
```bash
34-
pnpm add -D openapi-typescript openapi-typescript-server
34+
npm install -D openapi-typescript openapi-typescript-server
3535
```
3636

3737
Install runtime adapter (Express example):
3838

3939
```bash
40-
pnpm add openapi-typescript-server-express
40+
npm install openapi-typescript-server-express openapi-typescript-server-runtime
4141
```
4242

4343
**Recommended**: Install middleware for runtime validation:
4444

4545
```bash
46-
pnpm add express-openapi-validator
46+
npm install express-openapi-validator
4747
```
4848

4949
### Quickstart
@@ -102,13 +102,13 @@ First, follow [recommended setup from openapi-typescript](https://openapi-ts.dev
102102
Generate types from your OpenAPI spec:
103103
104104
```bash
105-
pnpm exec openapi-typescript ./openapi.yaml --output ./gen/schema.d.ts
105+
npx openapi-typescript ./openapi.yaml --output ./gen/schema.d.ts
106106
```
107107

108108
Generate the server interface:
109109

110110
```bash
111-
pnpm exec openapi-typescript-server ./openapi.yaml --types ./schema.d.ts --output ./gen/server.ts
111+
npx openapi-typescript-server ./openapi.yaml --types ./schema.d.ts --output ./gen/server.ts
112112
```
113113

114114
> **Note**: The `--types` path is relative to the output directory so the generated code can import it correctly.

0 commit comments

Comments
 (0)