{"repo":"sacconazzo/directus-extension-api-docs","free":true,"listed":false,"github":"https://github.com/sacconazzo/directus-extension-api-docs","clone":"git clone https://github.com/sacconazzo/directus-extension-api-docs.git","description":"directus extension for swagger interface and custom endpoints definitions and validations","language":"TypeScript","stars":45,"topics":["custom-endpoints","directus","directus-extension","openapi","swagger","validation","api-documentation","api-validator","zod","zod-validation"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"directus-extension-api-docs Compatible with Directus ^9 ^10 ^11 and both bundled and non-bundled endpoint extensions. Release notes: see CHANGELOG.md. Directus Extension providing: - a Swagger UI interface (OpenAPI 3.x) - an autogenerated OpenAPI specification file (merged core + your custom endpoints) -- including custom endpoint definitions - optional validation middleware for your custom endpoints (based on merged OpenAPI spec). See details below - optional Zod-first route definitions for type-safe validation + OpenAPI auto-generation (see Zod-first routes) Contents - Prerequisites - Installation - Configuration (optional) - Definitions (optional) — YAML - Validations (optional) — YAML-based runtime validation - Zod-first routes (optional) — type-safe alternative - YAML vs Zod - Contributing · Reporting issues · License Prerequisites You must already have a Directus Node.js project running. Ref: https://github.com/directus/directus Installation - Swagger interface: by default http://localhost:8055/api-docs - Openapi documentation: by default http://localhost:8055/api-docs/oas Configuration (optional) To include your custom endpoints in the documentation, create an oasconfig.yaml file directly under the /extensions folder (recommended structure). Avoid placing it under /extensions/endpoints unless using Legacy mode. Options: - docsPath optional interface base path (default 'api-docs'). Resulting URLs: / and / /oas . - info optional openapi server info (default extract from ","default_branch":null,"files":null,"tree":[],"storefront":"/r/sacconazzo","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/sacconazzo/directus-extension-api-docs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}