You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13Lines changed: 13 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,3 +9,16 @@ This API provides access to DDI metadata resources.
9
9
## OpenAPI Specification
10
10
11
11
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