Jump To Close Expand all Collapse all Table of contents Providing APIs in the Developer Portal Preface Making open source more inclusive I. OpenAPI Specification Expand section "I. OpenAPI Specification" Collapse section "I. OpenAPI Specification" 1. An introduction to OpenAPI Specification Expand section "1. An introduction to OpenAPI Specification" Collapse section "1. An introduction to OpenAPI Specification" 1.1. Command line options for importing OpenAPI documents in 3scale 1.2. Different sources to import API specifications 2. How to configure OpenAPI Specification Expand section "2. How to configure OpenAPI Specification" Collapse section "2. How to configure OpenAPI Specification" 2.1. OpenAPI Specification 3.0 usage with 3scale Expand section "2.1. OpenAPI Specification 3.0 usage with 3scale" Collapse section "2.1. OpenAPI Specification 3.0 usage with 3scale" 2.1.1. Configure the Developer Portal with OAS 3.0 2.2. OpenAPI Specification 2.0 usage with 3scale 2.3. Upgrading the Swagger user interface 2.1.3 to 2.2.10 II. API documentation in the Developer Portal Expand section "II. API documentation in the Developer Portal" Collapse section "II. API documentation in the Developer Portal" 3. Update To ActiveDocs 2.0 Expand section "3. Update To ActiveDocs 2.0" Collapse section "3. Update To ActiveDocs 2.0" 3.1. Step 1: Apply the appropriate naming convention to your specification 3.2. Step 2: Modify service spec 3.3. Step 3: Add the Javascript and HTML content to your CMS page 3.4. Step 4: Test your API using ActiveDocs 1.2 4. Adding ActiveDocs to 3scale Expand section "4. Adding ActiveDocs to 3scale" Collapse section "4. Adding ActiveDocs to 3scale" 4.1. Setting up ActiveDocs in 3scale 5. How to write an OpenAPI document for use as a 3scale OpenAPI spec Expand section "5. How to write an OpenAPI document for use as a 3scale OpenAPI spec" Collapse section "5. How to write an OpenAPI document for use as a 3scale OpenAPI spec" 5.1. Setting up 3scale ActiveDocs and OAS 5.2. OpenAPI document example: Petstore API 5.3. Additional OAS specification information 5.4. OAS design and editing tools 5.5. ActiveDocs auto-fill of API credentials 6. ActiveDocs and OAuth Expand section "6. ActiveDocs and OAuth" Collapse section "6. ActiveDocs and OAuth" 6.1. Example of client credentials and resource owner flows in a 3scale specification 6.2. Publishing ActiveDocs in the Developer Portal 7. APIcast self-managed (old version) and OAuth 2.0 Expand section "7. APIcast self-managed (old version) and OAuth 2.0" Collapse section "7. APIcast self-managed (old version) and OAuth 2.0" 7.1. Prerequisites 7.2. OAuth Configuration Expand section "7.2. OAuth Configuration" Collapse section "7.2. OAuth Configuration" 7.2.1. Step 1: Edit Integration Settings 7.2.2. Step 2: Declare your OAuth Authorization Endpoint 7.2.3. Step 3: Download the APIcast config files 7.3. Running your self-managed APIcast instance (production) Expand section "7.3. Running your self-managed APIcast instance (production)" Collapse section "7.3. Running your self-managed APIcast instance (production)" 7.3.1. Step 1: Install the dependencies (for Ubuntu) 7.3.2. Step 2: Compile and install OpenResty 7.3.3. Step 3: Install Redis 7.3.4. Step 4: Download the APIcast configuration from 3scale 7.3.5. Step 5: Start and stop APIcast 7.3.6. Step 6: Test your OAuth Flow Legal Notice Settings Close Language: 简体中文 日本語 한국어 English Language: 简体中文 日本語 한국어 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: 简体中文 日本語 한국어 English Language: 简体中文 日本語 한국어 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Preface An OpenAPI document that defines your API is the foundation for your Developer Portal. Previous Next