swagger接口的文档编写格式
时间: 2024-02-17 11:04:51 浏览: 224
Swagger接口文档通常使用OpenAPI规范编写,可以采用YAML或JSON格式。下面是一个基本的Swagger接口文档的格式:
```
swagger: '2.0'
info:
title: Sample API
description: API for accessing sample data
version: 1.0.0
host: api.example.com
basePath: /v1
schemes:
- https
consumes:
- application/json
produces:
- application/json
paths:
/sample:
get:
summary: Returns a list of samples
responses:
200:
description: A list of samples
schema:
type: array
items:
$ref: '#/definitions/Sample'
definitions:
Sample:
type: object
properties:
id:
type: integer
name:
type: string
description:
type: string
```
其中,`swagger`和`info`字段用于描述Swagger版本和API的信息。`host`和`basePath`字段用于指定API的基础URL。`schemes`字段用于指定API的协议,例如`https`、`http`等。`consumes`和`produces`字段用于指定API的请求和响应格式。`paths`字段用于描述API的请求路径和方法。`responses`字段用于描述API的响应。`definitions`字段用于定义API中使用的对象模型。
阅读全文