### Apifox Quick Start Guide Source: https://docs.apifox.com/url-link-conventions A guide to quickly get started with Apifox, covering essential steps from setup to testing. ```APIDOC Quick Start: - Overview - Create API - Send API Request - Quick Request - Add Assertions - Create Test Scenario - Share API Documentation - Learn More ``` -------------------------------- ### Apifox Quick Start Guide Source: https://docs.apifox.com/documentation-site-search-settings A guide to quickly get started with Apifox, covering essential steps from setup to testing. ```APIDOC Quick Start: - Overview - Create API - Send API Request - Quick Request - Add Assertions - Create Test Scenario - Share API Documentation - Learn More ``` -------------------------------- ### Apifox Quick Start Guide Source: https://docs.apifox.com/documentation-sidebar-settings A guide to quickly get started with Apifox, covering essential steps from setup to testing. ```APIDOC Quick Start: - Overview - Create API - Send API Request - Quick Request - Add Assertions - Create Test Scenario - Share API Documentation - Learn More ``` -------------------------------- ### Apifox Quick Start Guide Source: https://docs.apifox.com/documentation-visibility-settings A guide to quickly get started with Apifox, covering essential steps from setup to testing. ```APIDOC Quick Start: - Overview - Create API - Send API Request - Quick Request - Add Assertions - Create Test Scenario - Share API Documentation - Learn More ``` -------------------------------- ### Apifox Quick Start Guide Source: https://docs.apifox.com/google-analytics-integration A guide to quickly get started with Apifox, covering essential steps from setup to testing. ```APIDOC Quick Start: - Overview - Create API - Send API Request - Quick Request - Add Assertions - Create Test Scenario - Share API Documentation - Learn More ``` -------------------------------- ### Apifox Quick Start Guide Source: https://docs.apifox.com/share-document-proxy Steps for getting started with Apifox, including creating new APIs, sending requests, and setting up test scenarios. ```APIDOC Overview Create API Send API Request Quick Request Add Assertions Create Test Scenario Share API Documentation Learn More ``` -------------------------------- ### Apifox Quick Start Guide Source: https://docs.apifox.com/cross-origin-proxy A guide to quickly get started with Apifox, covering essential steps from setup to testing. ```APIDOC Quick Start: - Overview - Create API - Send API Request - Quick Request - Add Assertions - Create Test Scenario - Share API Documentation - Learn More ``` -------------------------------- ### Apifox Quick Start Guide Source: https://docs.apifox.com/5831265m0 A quick guide to getting started with Apifox, covering essential steps from initial setup to sending API requests and managing tests. It includes creating new APIs, sending requests, adding assertions, and creating test scenarios. ```APIDOC Quick Start: - Overview - Create API - Send API Request - Quick Request - Add Assertions - Create Test Scenario - Share API Documentation - Learn More ``` -------------------------------- ### Apifox Getting Started and Core Concepts Source: https://docs.apifox.com/introduction Guides new users through the initial steps of using Apifox, including product introduction, contact information, and private deployment options. It covers essential concepts like registration and login, page layout, and fundamental principles of API interaction. The quick start section includes creating APIs, sending requests, adding assertions, creating test scenarios, and sharing documentation. ```APIDOC Getting Started: - Product Introduction - Contact Us - Private Deployment Core Concepts: - Registration & Login - Page Layout - Basic Concepts Quick Start: - Overview - Create API: Define new API endpoints. - Send API Request: Execute requests to test APIs. - Quick Request: Perform rapid request testing. - Add Assertions: Define validation rules for responses. - Create Test Scenario: Group multiple requests for testing. - Share API Documentation: Distribute API documentation. ``` -------------------------------- ### Apifox Quick Start Guide Source: https://docs.apifox.com/client-side-request-proxy Steps for getting started with Apifox, including creating new APIs, sending requests, and setting up test scenarios. ```APIDOC Overview Create API Send API Request Quick Request Add Assertions Create Test Scenario Share API Documentation Learn More ``` -------------------------------- ### Apifox Quick Start Guide Source: https://docs.apifox.com/5831263m0 A quick guide to getting started with Apifox, covering essential steps from initial setup to sending API requests and managing tests. It includes creating new APIs, sending requests, adding assertions, and creating test scenarios. ```APIDOC Quick Start: - Overview - Create API - Send API Request - Quick Request - Add Assertions - Create Test Scenario - Share API Documentation - Learn More ``` -------------------------------- ### Apifox Quick Start Guide Source: https://docs.apifox.com/request-proxy-in-web Steps for getting started with Apifox, including creating new APIs, sending requests, and setting up test scenarios. ```APIDOC Overview Create API Send API Request Quick Request Add Assertions Create Test Scenario Share API Documentation Learn More ``` -------------------------------- ### Apifox Getting Started and Core Concepts Source: https://docs.apifox.com/doc-5751209 Guides new users through the initial steps of using Apifox, including product introduction, contact information, and private deployment options. It covers essential concepts like registration and login, page layout, and fundamental principles of API interaction. The quick start section includes creating APIs, sending requests, adding assertions, creating test scenarios, and sharing documentation. ```APIDOC Getting Started: - Product Introduction - Contact Us - Private Deployment Core Concepts: - Registration & Login - Page Layout - Basic Concepts Quick Start: - Overview - Create API: Define new API endpoints. - Send API Request: Execute requests to test APIs. - Quick Request: Perform rapid request testing. - Add Assertions: Define validation rules for responses. - Create Test Scenario: Group multiple requests for testing. - Share API Documentation: Distribute API documentation. ``` -------------------------------- ### Apifox Getting Started and Basic Concepts Source: https://docs.apifox.com/5801730m0 Guides for new users to get started with Apifox, covering product introduction, registration, login, page layout, and fundamental concepts. ```APIDOC Getting Started: - Product Introduction - Contact Us - Private Deployment - Download Apifox - Registration and Login - Page Layout - Basic Concepts Quick Start: - Overview - Create API - Send API Request - Quick Request - Add Assertions - Create Test Scenario - Share API Documentation - Learn More ``` -------------------------------- ### Apifox Getting Started and Basic Concepts Source: https://docs.apifox.com/5801731m0 Guides for new users to get started with Apifox, covering product introduction, registration, login, page layout, and fundamental concepts. ```APIDOC Getting Started: - Product Introduction - Contact Us - Private Deployment - Download Apifox - Registration and Login - Page Layout - Basic Concepts Quick Start: - Overview - Create API - Send API Request - Quick Request - Add Assertions - Create Test Scenario - Share API Documentation - Learn More ``` -------------------------------- ### Apifox Quick Start Guide Source: https://docs.apifox.com/request-url-and-method An introductory guide to getting started with Apifox, covering essential steps like creating APIs, sending requests, and setting up basic testing scenarios. ```APIDOC Quick Start: - Create API: - Steps to define a new API endpoint, including its method, URL, and parameters. - Send API Request: - How to construct and send a request to an API endpoint. - Quick Request: - Simplified method for sending requests without full definition. - Add Assertions: - Defining checks on API responses to validate correctness. - Create Test Scenario: - Grouping multiple API requests and assertions into a test suite. - Share API Documentation: - Options for sharing API documentation with team members or external stakeholders. ``` -------------------------------- ### Apifox Getting Started and Core Concepts Source: https://docs.apifox.com/siyouhua Guides new users through the initial steps of using Apifox, including product introduction, contact information, and private deployment options. It covers essential concepts like registration and login, page layout, and fundamental principles of API interaction. The quick start section includes creating APIs, sending requests, adding assertions, creating test scenarios, and sharing documentation. ```APIDOC Getting Started: - Product Introduction - Contact Us - Private Deployment Core Concepts: - Registration & Login - Page Layout - Basic Concepts Quick Start: - Overview - Create API: Define new API endpoints. - Send API Request: Execute requests to test APIs. - Quick Request: Perform rapid request testing. - Add Assertions: Define validation rules for responses. - Create Test Scenario: Group multiple requests for testing. - Share API Documentation: Distribute API documentation. ``` -------------------------------- ### Getting Started with Apifox Source: https://docs.apifox.com/self-hosted-runner Guides users through the initial steps of using Apifox, including product introduction, registration, layout, basic concepts, and quick start tutorials. ```APIDOC Product Introduction: /introduction Contact Us: /contact-us Private Deployment: /siyouhua Download Apifox: /download Sign Up and Login: /sign-up-and-login Page Layout: /page-layout Basic Concepts: /apifox-basic-concepts Quick Start Overview: /getting-started Create API: /create-api Send API Request: /send-api-request Quick Request: /quick-request Add Assertions: /add-assertions Create Test Scenario: /create-test-scenario Share API Documentation: /share-api-documentation Learn More: /learn-more ``` -------------------------------- ### Apifox Quick Start Guide Source: https://docs.apifox.com/automated-testing A guide for quickly getting started with Apifox, covering essential steps like creating APIs, sending requests, using quick requests, adding assertions, creating test scenarios, and sharing API documentation. ```APIDOC Quick Start: - Overview - Create API - Send API Request - Quick Request - Add Assertions - Create Test Scenario - Share API Documentation - Learn More ``` -------------------------------- ### Apifox Getting Started and Core Concepts Source: https://docs.apifox.com/contact-us Guides new users through the initial steps of using Apifox, including product introduction, contact information, and private deployment options. It covers essential concepts like registration and login, page layout, and fundamental principles of API interaction. The quick start section includes creating APIs, sending requests, adding assertions, creating test scenarios, and sharing documentation. ```APIDOC Getting Started: - Product Introduction - Contact Us - Private Deployment Core Concepts: - Registration & Login - Page Layout - Basic Concepts Quick Start: - Overview - Create API: Define new API endpoints. - Send API Request: Execute requests to test APIs. - Quick Request: Perform rapid request testing. - Add Assertions: Define validation rules for responses. - Create Test Scenario: Group multiple requests for testing. - Share API Documentation: Distribute API documentation. ``` -------------------------------- ### Oracle Instant Client Setup (macOS) Source: https://docs.apifox.com/oracle Steps to set up Oracle Instant Client on macOS for Apifox, including downloading, extracting, and creating a symbolic link for the client library. ```Shell ln -s ~/oracle/instantclient_19_8/libclntsh.dylib /usr/local/lib ``` -------------------------------- ### Install Jenkins on Linux Source: https://docs.apifox.com/integration-with-jenkins Provides step-by-step shell commands to install Jenkins on a Debian-based Linux system. It includes adding the Jenkins GPG key, configuring the APT repository, updating the package list, installing the Jenkins package, and starting the Jenkins service. ```shell wget -q -O - https://pkg.jenkins.io/debian/jenkins.io.key | sudo apt-key add - sudo sh -c 'echo deb http://pkg.jenkins.io/debian-stable binary/ > /etc/apt/sources.list.d/jenkins.list' sudo apt-get update sudo apt-get install jenkins sudo systemctl start jenkins ``` -------------------------------- ### LocalStorage Example Source: https://docs.apifox.com/5801722m0 Demonstrates setting and getting data from local storage, highlighting that modifications to retrieved objects do not affect the original stored data. ```Python def obj = ["a":"b"] localStorage.set("key",obj) localStorage.get("key")["a"]=c // Modifying the retrieved object does not affect the original obj obj["a"] == "b" // obj remains ["a":"b"] ``` -------------------------------- ### CI/CD Integrations Source: https://docs.apifox.com/multi-example-request-body Information on integrating Apifox with Continuous Integration and Continuous Deployment (CI/CD) platforms, including specific examples for popular tools. ```APIDOC CI/CD Integration: - Overview: - Description: General introduction to CI/CD capabilities in Apifox. - Link: /cicd - Jenkins Integration: - Description: How to integrate Apifox with Jenkins for automated workflows. - Link: /integration-with-jenkins - Gitlab Integration: - Description: Steps for integrating Apifox with Gitlab CI/CD. - Link: /integration-with-gitlab - Github Actions Integration: - Description: Guide for integrating Apifox with Github Actions. - Link: /integration-with-github-actions - Other CI/CD Platforms: - Description: Information on integrating with various other CI/CD platforms. - Link: /integration-with-other-ci-cd-platforms - Git Commit Triggered Testing: - Description: Setting up automatic test triggers based on Git commits. - Link: /git-commit-triggered-testing ``` -------------------------------- ### Apifox Best Practices Source: https://docs.apifox.com/sign-up-and-login Guidelines and best practices for using Apifox, covering data transfer between interfaces, handling authentication (Auth), interface signatures, data encryption/decryption, Jenkins integration, AI cost calculation, shared database connections, and running tests with cloud configurations. ```APIDOC Best Practices: - Overview: /5743521m0 - Data Transfer Between Interfaces: /5793498m0 - Handling Authentication (Auth): /5802184m0 - Handling Interface Signatures: /5802226m0 - Encrypt/Decrypt Interface Data: /5802338m0 - Jenkins Scheduled Tasks: /5802381m0 - Calculating AI Q&A Costs: /5835636m0 - Sharing Database Connection Configs: /6378711m0 - Running Tests with Cloud DB Configs via CLI: /6378956m0 - Running Tests with Cloud DB Configs via Runner: /6379146m0 - Passing Data Between Apifox Test Steps: /6822783m0 ``` -------------------------------- ### Getting Started with Apifox Mock Data Source: https://docs.apifox.com/mock To start using Apifox Mock, specify an interface or import API documentation with set return values. Then, copy the Mock URL from either the 'Document Mode' or 'Debug Mode' to access mock data. Refreshing the page updates the data. ```APIDOC Steps to use Apifox Mock: 1. Specify an interface or import API documentation with defined return values. 2. Copy the Mock URL: - In 'Document Mode': Found on the 'Interface' tab. - In 'Debug Mode': Found on the 'Mock' tab. 3. Access the URL to retrieve mock data. Data updates upon page refresh. ``` -------------------------------- ### Getting Started with Apifox Mock Data Source: https://docs.apifox.com/5589818m0 To start using Apifox Mock, specify an interface or import API documentation with set return values. Then, copy the Mock URL from either the 'Document Mode' or 'Debug Mode' to access mock data. Refreshing the page updates the data. ```APIDOC Steps to use Apifox Mock: 1. Specify an interface or import API documentation with defined return values. 2. Copy the Mock URL: - In 'Document Mode': Found on the 'Interface' tab. - In 'Debug Mode': Found on the 'Mock' tab. 3. Access the URL to retrieve mock data. Data updates upon page refresh. ``` -------------------------------- ### Apifox Dubbo Project Setup and Interface Creation Source: https://docs.apifox.com/create-dubbo-api This section details the process of setting up a Dubbo project in Apifox and manually creating Dubbo interfaces. It covers the creation of packages, services, and methods, including handling version and group information for Dubbo services. ```APIDOC Project Setup: 1. Open Apifox and navigate to your team. 2. Click the 'New Project' button. 3. Select 'Dubbo Project' as the project type. 4. Enter a project name and choose the 'Project Language' (e.g., Java). Manual Interface Creation: - For a Dubbo interface like `demo/com.dubbo.example.DemoService:1.0.1`: 1. Create Package: - In the Dubbo project, click the '+' icon and select 'New Package'. - Enter the Package name (e.g., `demo`). - Specify the directory. 2. Create Service: - Within the created Package, click to add a Service. - Enter the Service name (e.g., `com.dubbo.example.DemoService`). - If the service has a version and group, fill them in the respective fields. - Version: e.g., `1.0.1` - Group: e.g., `group1` 3. Create Method: - Within the Service, click to add a Method. - Define the Method name (e.g., `sayHello`). - Configure request parameters and response structures as needed. ``` -------------------------------- ### Node.js GPT Token Counter Setup Source: https://docs.apifox.com/5835636m0 Instructions for setting up a Node.js script to count tokens for AI model inputs. This involves initializing a Node.js environment and installing the 'openai-gpt-token-counter' library. ```bash npm init -y npm install openai-gpt-token-counter ``` -------------------------------- ### Apifox Test Scenario Setup Source: https://docs.apifox.com/5984981m0 Guidance on setting up common configurations for test scenarios, such as server hosts and pre-request operations. ```APIDOC Test Scenario Setup: - Runner Server Host: Configuring the server host for general Runner settings in the Web version. - Pre-request Operations: Applying unified pre-request operations to requests within a test scenario. ``` -------------------------------- ### Configure HTTP Method for Methods Source: https://docs.apifox.com/5801721m0 Set the HTTP request method for API documentation. The default is POST. This configuration allows setting the method dynamically, for example, to GET for methods without parameters. ```groovy mdoc.method.http.method=groovy:it.argCnt()==0?"GET":null // Sets method to GET if the method has no arguments, otherwise uses default. ``` -------------------------------- ### Publishing API Documentation Source: https://docs.apifox.com/cloud-mock Guides on publishing and sharing API documentation, including quick sharing, viewing documentation, publishing documentation sites, customizing layouts, and advanced settings like custom domains and SEO. ```APIDOC Publishing API Documentation: - Overview: Introduction to API documentation features. - Quick Share: Easily sharing documentation links. - View API Documentation: Accessing and browsing published documentation. - Publish Documentation Site: Creating and deploying a public documentation portal. - Page Layout Settings: Customizing the appearance of documentation pages. - Custom Code (CSS/JS/HTML): Injecting custom code for styling or functionality. - Custom Domain: Using a custom domain name for the documentation site. - AI Features: Leveraging AI for documentation enhancement. - SEO Settings: Optimizing documentation for search engines. - Advanced Settings: - Documentation Site Search Settings. - Cross-Origin Proxy: Configuring proxy settings for documentation access. - Google Analytics Integration: Tracking site visitors. - Documentation Sidebar Settings: Customizing the navigation menu. - Documentation Visibility Settings: Controlling access to documentation. - URL Link Conventions: Defining URL structures for documentation. ``` -------------------------------- ### Database Connection Configuration Example Source: https://docs.apifox.com/%E9%80%9A%E7%94%A8-runner-5714000m0 An example JSON structure for configuring database connections that can be used by the Runner. This file should be placed in the specified directory on the server. ```json { "19731": { "configs": { "default": { "username": "accountname", "password": "123456", "host": "192.168.0.0" } }, "id": 19731, "name": "Database Name", "type": "mysql", "projectId": 1320441, "description": "Dummy data.", "createdAt": "2022-09-27T07:51:09.000Z", "updatedAt": "2024-05-09T11:38:07.000Z", "deletedAt": null } } ``` -------------------------------- ### Apifox IDE Plugin Features Source: https://docs.apifox.com/design-api Details the functionalities offered by the Apifox IDEA plugin, including quick start guides, generating API documentation, and creating data models. ```APIDOC Apifox IDEA Plugin: - Quick Start: /apifox-idea-plugin - Generate API Documentation: /generate-api-docs-with-idea - Generate Data Schemas: /generate-data-schemas-with-idea - Configuration: - Global Configuration: /5801717m0 - Project-Specific Configuration: /5801720m0 - Configurable Rules: /5801721m0 - Scripting Tools: /5801722m0 - Groovy Local Extensions: /5801723m0 - Advanced Configuration: - Comment Specification: /5801730m0 - Framework Support: /5801731m0 - FAQs: /apifox-idea-plugin-faqs ``` -------------------------------- ### Apifox IDEA Plugin Features Source: https://docs.apifox.com/api-changes-in-sprint-branch Details on the functionalities offered by the Apifox IDEA plugin, including quick start guides, generating API documentation, creating data models, and configuration options for projects and rules. ```APIDOC IDEA Plugin: - Quick Start: /apifox-idea-plugin - Generate API Docs: /generate-api-docs-with-idea - Generate Data Models: /generate-data-schemas-with-idea Configuration: - Global Configuration: /5801717m0 - Project Configuration: /5801720m0 - Configurable Rules: /5801721m0 - Script Tools: /5801722m0 - Groovy Local Extension: /5801723m0 Advanced Configuration: - Comment Specification: /5801730m0 - Framework Support: /5801731m0 FAQs: /apifox-idea-plugin-faqs ``` -------------------------------- ### Publishing API Documentation Source: https://docs.apifox.com/smart-mock Guides on publishing and sharing API documentation, including quick sharing, viewing documentation, publishing documentation sites, customizing layouts, and advanced settings like custom domains and SEO. ```APIDOC Publishing API Documentation: - Overview: Introduction to API documentation features. - Quick Share: Easily sharing documentation links. - View API Documentation: Accessing and browsing published documentation. - Publish Documentation Site: Creating and deploying a public documentation portal. - Page Layout Settings: Customizing the appearance of documentation pages. - Custom Code (CSS/JS/HTML): Injecting custom code for styling or functionality. - Custom Domain: Using a custom domain name for the documentation site. - AI Features: Leveraging AI for documentation enhancement. - SEO Settings: Optimizing documentation for search engines. - Advanced Settings: - Documentation Site Search Settings. - Cross-Origin Proxy: Configuring proxy settings for documentation access. - Google Analytics Integration: Tracking site visitors. - Documentation Sidebar Settings: Customizing the navigation menu. - Documentation Visibility Settings: Controlling access to documentation. - URL Link Conventions: Defining URL structures for documentation. ``` -------------------------------- ### Apifox Reference Materials Source: https://docs.apifox.com/design-api Reference guides on API design principles, data formats, and technical concepts including API-First, JSON Schema, JSONPath, XPath, Markdown, CSV, Regex, and environment setup. ```APIDOC Reference Materials: - API Design First Philosophy: /api-first-design - JSON Schema Introduction: /json-schema - JSONPath Introduction: /jsonpath - XPath Introduction: /xpath - Apifox Markdown Syntax: /apifox-markdown - CSV Format Specification: /csv - Regular Expressions: /regex - Install Java Environment: /install-java - Runner Environment: /runner-environment - Data Types in Programming Languages: /programming-data-types - Socket Packet Fragmentation and Merging: /socket-packet-fragmentation-and-merging - Glossary: /glossary ``` -------------------------------- ### Apifox Reference Materials Source: https://docs.apifox.com/sign-up-and-login Reference materials for Apifox users, covering concepts like API-first design, JSON Schema, JSONPath, XPath, Apifox Markdown, CSV format, regular expressions, environment setup for runners, data types, and socket packet handling. ```APIDOC Reference Materials: - API First Design: /api-first-design - JSON Schema Introduction: /json-schema - JSONPath Introduction: /jsonpath - XPath Introduction: /xpath - Apifox Markdown Syntax: /apifox-markdown - CSV Format Specification: /csv - Regular Expressions: /regex - Install Java Environment: /install-java - Runner Environment: /runner-environment - Data Types for Programming Languages: /programming-data-types - Socket Packet Fragmentation and Merging: /socket-packet-fragmentation-and-merging - Glossary: /glossary ``` -------------------------------- ### Apifox API Creation Guide Source: https://docs.apifox.com/create-api This documentation outlines the process of creating a new API endpoint in Apifox. It details defining the request path, specifying path parameters with their types and example values, setting up response structures for success codes, referencing existing data models, adding and generating response examples, and finally saving the API definition. It also mentions the alternative of importing existing OpenAPI/Swagger files. ```APIDOC APIDOC: Create API Endpoint: Steps: 1. Open a new tab and click 'New API'. 2. Define Request Path: Enter the path, e.g., `/category/{id}`. - Name: e.g., 'Get Category by ID' - Path Parameters: - Name: `id` Type: `integer` Example: `1` 3. Set Response Structure: - Under 'Success(200)', click '+' to create a field, e.g., 'data'. - Set 'data' field type to 'Object' and select 'Reference Model'. - Choose a data model (e.g., 'Category'). 4. Add Response Example: - In 'Response Example' section, click 'Add Example'. - Name the example (e.g., 'Success Example'). - Click 'Auto Generate' to populate data. - Click 'Confirm' to save the example. 5. Save API: Click the 'Save' button. Alternative: - Import existing OAS files (OpenAPI/Swagger .json or .yaml) instead of manual creation. ``` -------------------------------- ### Publishing API Documentation Source: https://docs.apifox.com/mock-scripts Guides on publishing and sharing API documentation, including quick sharing, viewing documentation, publishing documentation sites, customizing layouts, and advanced settings like custom domains and SEO. ```APIDOC Publishing API Documentation: - Overview: Introduction to API documentation features. - Quick Share: Easily sharing documentation links. - View API Documentation: Accessing and browsing published documentation. - Publish Documentation Site: Creating and deploying a public documentation portal. - Page Layout Settings: Customizing the appearance of documentation pages. - Custom Code (CSS/JS/HTML): Injecting custom code for styling or functionality. - Custom Domain: Using a custom domain name for the documentation site. - AI Features: Leveraging AI for documentation enhancement. - SEO Settings: Optimizing documentation for search engines. - Advanced Settings: - Documentation Site Search Settings. - Cross-Origin Proxy: Configuring proxy settings for documentation access. - Google Analytics Integration: Tracking site visitors. - Documentation Sidebar Settings: Customizing the navigation menu. - Documentation Visibility Settings: Controlling access to documentation. - URL Link Conventions: Defining URL structures for documentation. ``` -------------------------------- ### Share API Documentation Guide Source: https://docs.apifox.com/share-api-documentation Steps to share API documentation after development and debugging. This includes creating a new share, configuring environments, and accessing the shared link. It also details how to interact with shared APIs, such as debugging and generating example code. ```APIDOC ## Share API Documentation **Purpose:** To publish developed and debugged APIs as shareable documentation. **Steps:** 1. Navigate to the **"Share Document"** module. 2. Click **"New Share"** to create a new shared document. 3. Provide a title, select all environments, and click **"Save"**. 4. The new share will appear in the list. Click **"Open Link"** to view it in a web browser. 5. Within the shared document, users can switch between different APIs using the left-side directory tree. 6. For each API, users can click the **"Debug"** button to send requests and generate example code. **Additional Features:** Apifox supports custom document layouts, custom domains, and custom URLs for shared documentation. **Related:** [Publish Documentation Site](/publish-documentation-site) ``` -------------------------------- ### API Debugging - Dubbo Source: https://docs.apifox.com/cloud-mock Guides for debugging Dubbo interfaces within Apifox, covering the creation, debugging, and documentation of Dubbo APIs. This section details the process from setting up a new Dubbo interface to understanding its documentation. ```APIDOC Dubbo Debugging: - Create Dubbo Interface: Steps to define and create a new Dubbo API endpoint. - Debug Dubbo Interface: How to send requests and inspect responses for Dubbo services. - Dubbo API Documentation: Information on generating and viewing documentation for Dubbo APIs. ``` -------------------------------- ### substringsBetween: Get All Strings Between Delimiters Source: https://docs.apifox.com/5801722m0 Searches a String for substrings delimited by start and end tags, returning all matching substrings in an array. Returns null if input string, open, or close delimiters are null. An empty open and close returns null. ```APIDOC tool.substringsBetween("abc", "", "") = "a","b","c" tool.substringsBetween(null, *, *) = null tool.substringsBetween(*, null, *) = null tool.substringsBetween(*, *, null) = null tool.substringsBetween("", "", "") = Params: str: string open: string close: string Return: array: a String Array of substrings, or {@code null} if no match string: ``` -------------------------------- ### Apifox CLI Overview Source: https://docs.apifox.com/pre-request-scripts Provides an overview of the Apifox Command Line Interface (CLI), including installation, running commands, and available options for automating API testing and deployment workflows. ```APIDOC Apifox CLI: Overview: Provides an overview of the Apifox CLI. Installation and Running CLI: Details on how to install and execute the Apifox CLI. CLI Command Options: Lists and explains all available command-line options for interacting with Apifox features. ```