Skip to content

Commit 87d40c8

Browse files
committed
Add documentation in README file
1 parent e34389c commit 87d40c8

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,16 @@ This API provides access to DDI metadata resources.
99
## OpenAPI Specification
1010

1111
The API specification is available in the `ddi-rest.yaml` file in OpenAPI 3.1.1 format.
12+
13+
## Documentation & Links
14+
15+
### Online Documentation
16+
17+
- **Swagger UI**: [View on GitHub Pages](https://nicolaval.github.io/DDI-API/)
18+
19+
### Local Development
20+
21+
To view and test the API specification locally:
22+
23+
- **Swagger Editor**: Open [https://editor.swagger.io/](https://editor.swagger.io/) and paste the contents of `ddi-rest.yaml` or load it directly from the repository
24+
- **Local Swagger UI**: Run `yarn build:swagger` and `yarn preview:swagger` to start a local Swagger UI server

0 commit comments

Comments
 (0)