directus-extension-api-docs 1.9.7 → 1.9.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
# directus-extension-api-docs
|
|
2
2
|
|
|
3
3
|
Directus Extension to include
|
|
4
|
-
|
|
5
|
-
-
|
|
6
|
-
-
|
|
4
|
+
|
|
5
|
+
- a Swagger interface
|
|
6
|
+
- configurable autogenerated openapi documentation file
|
|
7
|
+
-- custom endpoint definitions included
|
|
8
|
+
- validation middleware on your custom endpoints (based on your openapi)
|
|
7
9
|
|
|
8
10
|
|
|
9
11
|
|
|
@@ -21,9 +23,12 @@ Ref: https://github.com/directus/directus
|
|
|
21
23
|
|
|
22
24
|
npm install directus-extension-api-docs
|
|
23
25
|
|
|
26
|
+
- Swagger interface: by default `http:localhost:8055/api-docs`)
|
|
27
|
+
- Openapi documentation: by default `http://localhost:8055/api-docs/oas`)
|
|
28
|
+
|
|
24
29
|
## Configuration (optional)
|
|
25
30
|
|
|
26
|
-
|
|
31
|
+
To include you custom endpoints in your documentation.
|
|
27
32
|
|
|
28
33
|
Create a `oasconfig.yaml` file under `/extensions/endpoints` folder.
|
|
29
34
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "directus-extension-api-docs",
|
|
3
|
-
"version": "1.9.
|
|
3
|
+
"version": "1.9.8",
|
|
4
4
|
"description": "directus extension for swagger interface and openapi including custom endpoints definitions // custom endpoint validations middleware based on openapi",
|
|
5
5
|
"licence": "MIT",
|
|
6
6
|
"icon": "api",
|