这段时间学习使用node中swagger模块定义、设计API,由于某些需要,需要将API的ID、名字name、类型type、参数argument和URL传给前端显示。于是想到使用写一个简单的接口,将这些数据传给前端。最近一直在使用node,所以决定使用node完成yaml文件的解析,并将解析结果传给前端。下面主要记录一下解析过程。
yaml文件
swagger: "2.0"
info:
version: "0.0.1"
title: A simple API Gateway
# during dev, should point to your local machine
host: www.api.com:8000
# basePath prefixes all resource paths
basePath: /
#
schemes:
# tip: remove http to make production-grade
- http
- https
# format of bodies a client can send (Content-Type)
consumes:
- application/json
# format of the responses to the client (Accepts)
produces:
- application/json
paths:
/bookTo:
# binds a127 app logic to a route
x-swagger-router-controller: ServiceController
x-ID: "001"
x-name: "airlineBookTo"
get:
description: 预订往航班机票
deprecated: false
tags:
- "机票"
# used as the method name of the controller
operationId: airlineBookTo
parameters:
-