SpexDockSpexDock
أيقونة عملية الربط

SpexDock

API documentation, the Notion way.
  • المستورِد
API documentation, the Notion way.

نبذة

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.

طريقة الاستخدام

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.