• Swagger描述规范

    总体要求

    由于HZERO平台是产品或项目实施的基础平台，通过Swagger进行管理的API说明对使用极为重要。
    主要分三块：

    1. API目录描述（必须）
    2. API描述（必须）
    3. API参数描述（可选）

    1.Swagger中API目录描述结构（英文描述：中文描述）

    2.Swagger中API描述结构

    3.Swagger中API参数描述结构

    URL参数

    Body参数

    使用方式

    以下实例均来源于hzero-file文件服务

    1.Swagger中API目录描述
    每个微服务应用增加一个SwaggerApi配置类，用于配置API目录的Tag，保持API的Controller对应，另外在API的Controller中用注解进行申明。


    2.Swagger中API描述

    3.Swagger中API参数描述
    URL参数

    Body参数