https://github.com/sophie-app/odpt-openapi
ODPT API Specs with TypeSpec
https://github.com/sophie-app/odpt-openapi
odpt openapi typespec
Last synced: 10 months ago
JSON representation
ODPT API Specs with TypeSpec
- Host: GitHub
- URL: https://github.com/sophie-app/odpt-openapi
- Owner: sophie-app
- Created: 2024-10-18T02:58:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-05T15:47:16.000Z (about 1 year ago)
- Last Synced: 2025-03-19T17:11:16.794Z (11 months ago)
- Topics: odpt, openapi, typespec
- Homepage: https://sophie-app.github.io/odpt-openapi/
- Size: 237 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ODPT OpenAPI
OpenAPI specification of ODPT API
## About ODPT API
- [Official Document](https://developer.odpt.org/documents)
- [Datasets](https://ckan.odpt.org/dataset)
## Development
### Requirements
- Node.js
- pnpm
### Setup
1. Install dependencies
```bash
pnpm i
```
2. (Optional) Install VSCode Extension
```bash
pnpm tsp code install
```
3. Start TypeSpec watcher and Document server
```bash
pnpm dev
```
Document page will be available at [`http://127.0.0.1:8080`](http://127.0.0.1:8080)
### Scripts
- `pnpm dev`: Run TypeSpec watcher and Document Server
- `pnpm build`: Compile TypeSpec and Build document page
- `pnpm check`: Check TypeSpec format and OpenAPI lint
- `pnpm fix`: Fix TypeSpec format