連接圖示

SpexDock

Overview

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.

How to use

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.

在此提及的所有第三方商標(含標誌和圖示)皆為各自擁有者的財產。除非特別標明「使用 Notion 製作」,否則 Notion 不負責整合的支援和維護服務。整合所連接的第三方產品或服務將被視為「非 Notion 應用程式」(定義請見 Notion 的主要訂閱協議個人使用條款,如適用)。如啟用整合或使用 Notion 整合庫,即代表你同意 Notion 的整合庫條款.