Información
SpexDock is a Notion integration that automates the generation of API documentation from OpenAPI (Swagger) specifications. It allows development teams to keep their API docs organized and up-to-date directly within Notion. Users provide an OpenAPI file (JSON/YAML) via URL, raw text, or webhook. SpexDock then parses the specification and transforms it into structured Notion pages, including endpoint details, parameters, request/response examples, and code snippets in various languages. This ensures a consistent, readable, and easily maintainable documentation source within a familiar collaborative environment.
Funciones
- Leer, insertar y actualizar contenidoPuede leer, insertar y actualizar páginas, bases de datos y bloques compartidos con esta conexión.
Cómo se usa
1. Log In to SpexDock: Go to https://spexdock.com and click on the Sign In link, then Sign in or create an account.
2. Go to the "Settings" section.
3. In Settings, click "Connect to Notion" and grant access to your workspace and desired pages.
4. Navigate to the "Specifications" section and click "+ Sync Job".
5. Name Your API: Enter a descriptive name for your API (e.g., "Payments API").
6. Select Notion Page: Choose a Notion page from the "Notion Parent Page" dropdown. It will also allow you create a new page.
7. Provide Spec URL: Enter the public URL to your openapi.json or openapi.yaml file in the "OpenAPI Spec URL" field.
8. Click the "Save" button to save your specification sync job. SpexDock will automatically perform the initial sync and schedule future updates based on your plan.
9. You will be taken back to the specifications list, where you will see your new specification item and a button labeled "Open in Notion.” Click on it to view your API documentation in Notion.
Detalles
- Programación
- Automatizaciones