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
+38Lines changed: 38 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,8 @@ REST API for DDI (Data Documentation Initiative), an international standard for
6
6
7
7
This API provides access to DDI metadata resources.
8
8
9
+
For detailed API usage, endpoints, and examples, see the [Mock API Endpoints Documentation](docs/MOCK_API_ENDPOINTS.md).
10
+
9
11
## OpenAPI Specification
10
12
11
13
The API specification is available in the `ddi-rest.yaml` file in OpenAPI 3.1.1 format.
@@ -22,3 +24,39 @@ To view and test the API specification locally:
22
24
23
25
-**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
26
-**Local Swagger UI**: Run `yarn build:swagger` and `yarn preview:swagger` to start a local Swagger UI server
27
+
-**Local Mock Server**: Run `yarn mock` to start a mock API server for testing
28
+
29
+
### Accept Header
30
+
31
+
The API supports multiple response formats. Use the `Accept` header to specify your preferred format:
0 commit comments