接口文档

一份清晰的接口文档文档有利于团队内开发者之间的相互协作，可以有效避免消费者和提供者对接口参数产生分歧而导致的调用错误，能够提升团队整体的接口协作效率。

你可以在 Dubbo 项目中为接口定义「请求」和「响应」。点击 Dubbo 接口中的“接口定义” Tab 页进行设置。

请求定义

请求定义中包含了请求参数和请求示例两部分内容。你可以添加多个请求参数或数据模型（DTO），并为每个参数添加对应的示例。

支持依照请求参数中数据模型自动生成请求示例，也可以手动进行编辑。

响应定义

响应定义用于描述接口服务端的预期响应结果。你可以使用 JSON、 XML、 JSON Schema、 MySQL DDL、 Mockjs 格式文件便捷导入。

接口说明

你可以在「接口说明」Tab 页中添加接口的详细描述，包括接口的功能、使用场景、注意事项、接口状态和相关责任人等。

预览文档

添加请求定义、响应定义和接口说明后，系统将自动生成接口文档。你可以点击「文档预览」 Tab 按钮查看 Dubbo 接口文档。