Apicat Docs
  1. Best practices
Apicat Docs
  • What is Apicat?
  • Send requests
    • Create requests
      • Request basics
      • Parameters and body
      • Request headers
      • Request settings
      • Dynamic values
      • HTTP/2
      • SOAP/WebService
    • Authentication and authorization
      • Overview
      • CA and client certificates
      • Authorization types supported by Apidog
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Response and cookies
      • Overview
      • API response in Apidog
      • Create and send cookies
      • Debug requests
    • Dynamic values Modules
      • Airline
      • Animal
      • Color
      • Commerce
      • Company
      • Database
      • Datatype
      • Date
      • Finance
      • Food
      • Git
      • Hacker
      • Helpers
      • Image
      • Internet
      • Location
      • Lorem
      • Music
      • Number
      • Person
      • Phone
      • Science
      • String
      • System
      • Vehicle
      • Word
  • Environments & variables
    • Overview
    • Using variables
    • Environments & services
  • Pre/Post processors
    • Overview
    • Assertion
    • Extract variable
    • Wait
    • Database operations
      • Overview
      • MySQL
      • MongoDB
      • Redis
      • Oracle Client
    • Using scripts
      • Overview
      • Pre processor scripts
      • Post processor scripts
      • Public scripts
      • Postman scripts reference
      • Calling other programming languages
      • Using JS libraries
      • Visualizing responses
      • Script examples
        • Assertion scripts
        • Using variables in scripts
        • Using scripts to modify request messages
        • Other examples
  • Best practices
    • How to handle API signatures
    • How to access OAuth 2.0 protected APIs
    • Apidog collaboration workflow
    • Managing authentication state in Apidog
  • Account & preferences
    • Account settings
    • Generate OpenAPI access token
    • Language settings
    • Hot keys
    • Network proxy configuration
    • Data backup
    • Updating Apidog
    • Deleting account
    • Experimental Features
  • References
    • API-Design First Approach
    • Apidog OpenAPI/Swagger Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Install Java Environment
    • Runner deployment environment
    • Apidog flavored Markdown
  1. Best practices

Apidog collaboration workflow

This article will guide you through the best practices for API collaboration workflow in Apidog.

Best practices#

1.
Draft API Documentation: API designer create initial API documentation in Apidog.
2.
Collaborative Review: Front-end and back-end developers work together to review and enhance the documentation, ensuring alignment on API use cases.
3.
Development Kickoff with Mock Data: Front-end developers can start development using automatically generated mock data based on API documentation in Apidog, eliminating the need for manual mock rule creation.
4.
Debugging with API Use Cases: Back-end developers debug the APIs during development. Completion of API development is confirmed when all use cases pass debugging. Any changes made during development automatically update the API specification, ensuring timely and cost-effective API maintenance.
5.
Saving Functions: Once debugging is complete, back-end developers can save the request as an endpoint case.
6.
API Testing: QA engineers can directly test APIs using predefined endpoint case.
7.
Integration Testing: After all APIs are developed, QA engineers (or back-end developers) can utilize the test collection feature to conduct comprehensive multi-API integration testing, ensuring the smooth functioning of the API calling process.
8.
Joint Debugging: Smooth joint debugging occurs when front-end and back-end development is finished, and front-end developers switch from mock data to real data, following the API specifications meticulously.
Modified at 2025-06-25 07:57:16
Previous
How to access OAuth 2.0 protected APIs
Next
Managing authentication state in Apidog
Built with