연결 아이콘

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.

여기에 나타나는 모든 제3자 상표(로고 및 아이콘 포함)는 해당 소유자의 자산입니다. Made by Notion으로 특별히 지정된 통합 외의 API 통합은 Notion에서 지원하거나 관리하지 않습니다. API 통합으로 연결되는 제3자 프로덕트 또는 서비스는 비 Notion 애플리케이션(Notion의 MSA(마스터 구독 계약) 또는 개인 이용약관에 따른 정의)입니다. API 통합을 활성화하거나 Notion API 통합 갤러리를 사용하는 경우, Notion의 API 통합 갤러리 약관에 동의하는 것으로 간주됩니다..

Powered by Fruition