用例:前端命中/openapi.json
并获取规范。它使用此响应来填充文档页面。
openapi.yml
看起来像:
openapi: 3.0.0
info:
title: An API.
version: 0.1.0
description: A description.
paths:
/status-check:
$ref: '...'
/foo/auth:
description: A descrioption.
get:
operationId: foo.foo1.foo2.function
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
sftp_hostname:
type: string
ssh_keys:
type: array
items:
type: string
'404':
description: A description.
'500':
description: A description.
如果您不想paths
在文档页面中填充其中一个的规格怎么办?在上述情况下,如果我不希望前端接收有关/foo/auth
端点的信息怎么办?
您可以禁用提供规范https://github.com/zalando/connexion#swagger-json但我找不到任何东西(例如标志)来隐藏特定端点的规范。