doc-apis doc-apis
💋Home
  • v1.0.0(current verison)
  • What's New

    • What' s New In doc-apis v1.0.0 ?
💖Charge
  • Community
  • Project PPT (opens new window)
  • Introduction
  • Member
  • PR
  • Join us
  • Customer
  • Easy-Es (opens new window)
  • Fit-Plan-Generator (opens new window)
  • Gitee (opens new window)
  • Github (opens new window)
  • English (opens new window)
  • 简体中文 (opens new window)

Advs are displayed by random carousel. ❤️Become a sponsor
💋Home
  • v1.0.0(current verison)
  • What's New

    • What' s New In doc-apis v1.0.0 ?
💖Charge
  • Community
  • Project PPT (opens new window)
  • Introduction
  • Member
  • PR
  • Join us
  • Customer
  • Easy-Es (opens new window)
  • Fit-Plan-Generator (opens new window)
  • Gitee (opens new window)
  • Github (opens new window)
  • English (opens new window)
  • 简体中文 (opens new window)
  • Quick Start Guide

    • Introduction
    • Applicable scenarios
    • Concerns rushed
    • Quick start demo
    • Other projects
    • Config
    • Annotation
  • Expand function

    • Interface debug
      • Interface debug
  • Others

    • FAQ
    • Update log
    • Update plan
    • Copyright
    • Acknowledgments
  • v1.xDocument
  • Expand function
LaoHan
2023-03-18
目录

Interface debug

# Interface debug

After the API documentation is generated, open the index page via a browser and navigate to the specific interface you need to debug through the left-hand directory. 1 The default global request URL is localhost:8080,, which can be modified through the Servers input box at the top of the page.

2 Global request headers can be configured on the homepage. Once configured, all interfaces will carry these headers when making requests. If special configurations are needed for specific interfaces, you may set their headers individually. Headers configured for a specific interface only apply to that interface and have the highest priority. In case of a key conflict between global headers and those set for a specific interface, the latter takes precedence.

tip tip

Due to the requirement of maintaining a zero-intrusion characteristic, necessary information cannot be stored in the database via backend interfaces. Therefore, all header information is stored in cookies. If you inadvertently clear your browser cookies, you'll need to reconfigure the header information.

The request method of an interface is determined by the annotations on the interface itself, with the backend code's specification as the standard. For example, if the @GetMapping󠁪 annotation is specified for interface A in the backend's Controller, then the request method for that interface is GET. Similarly, other annotations like @PostMapping󠁪, @PutMapping󠁪, @DeleteMapping󠁪, @PatchMapping󠁪, and @RequestMapping󠁪 are also effective. When a request is initiated, the appropriate request type is automatically invoked, along with parameter types such as URL parameters, form data, or JSON, as determined by the backend code. As long as the backend code adheres to the standards, no additional configuration or operation is needed; the framework will automatically specify the parameter type.Its usage is essentially similar to Swagger and Postman, very user-friendly; hence, further elaboration is unnecessary. Gentlemen, please refer directly to the screenshots for a visual demonstration.


3

Help us improve this document (opens new window)
lastUpdated: 2024/07/12
Annotation
FAQ

← Annotation FAQ→

Theme by Vdoing | Copyright © 2024-2024 LaoHan | MIT License
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式