swagger & api

swagger ui


# run server
$ swagger project start api-app # call api
$ curl http://127.0.0.1:8080/hello?name=xgqfrms
# { "message": "Hello, xgqfrms!" }
# http://localhost:8080/users

# install CLI
$ npm i -g swagger # create a new swagger project
$ swagger project create api-app # editor API
$ swagger project edit api-app # run server
$ swagger project start api-app # call api
$ curl http://127.0.0.1:8080/hello?name=xgqfrms
# { "message": "Hello, xgqfrms!" }

controller


function hello(req, res) {
var name = req.swagger.params.name.value || 'stranger';
var hello = util.format('Hello, %s!', name);
res.json({"message": hello});
}
    paths:
/hello:
x-swagger-router-controller: hello_world

./api/controllers

./api/controllers/hello_world.js


{
"name": "swagger_api_test",
"author": {
"name": "xgqfrms"
},
"version": "1.0.0",
"description": "swagger_api_test",
"license": "MIT",
"scripts": {
"app": "npm run server"
}
}


error

bug


Error initializing middleware
Error: Swagger document(s) failed validation so the server cannot start

https://github.com/swagger-api/swagger-node/issues/354


solution

solution


$ cd ./api/swagger && swagger validate swagger.yaml


- & yaml bug

missing - symbol bug


bug & solution

Error: Response validation failed: failed schema validation

https://github.com/xgqfrms/swagger-api/issues/5#issuecomment-430860246


最新文章

  1. JavaScript系列文章:自动类型转换
  2. JDK7学习笔记之基础类型
  3. System.exit(0)和System.exit(1)区别
  4. Storm启动流程简介
  5. windows Azure 域名绑定
  6. fuel openstack 在 VirtualBox 上的部署
  7. 每天进步一点点——Linux系统时间来处理
  8. Hash表的扩容(转载)
  9. ADO.NET FOR MySQL帮助类
  10. C# 获取Get请求返回
  11. Inno setup 中 执行参数传递注意的地方
  12. Python dir()/help()
  13. iOS下JS与OC互相调用(四)--JavaScriptCore
  14. fixed元素随滚动条无抖动滚动
  15. SQL Server系统表sysobjects介绍
  16. Windows7 Autoconfiguration IPv4 Address 导致无法上网
  17. redis重要知识点
  18. 关于anguar2微信支付问题
  19. 电子产品使用感受之--Mac Mini 买了之后有什么用?-- 开发啊!
  20. iCheck .js各种各样的插件 fuck Javascript

热门文章

  1. Fighting
  2. Mybatis查询select操作
  3. 424 Longest Repeating Character Replacement 替换后的最长重复字符
  4. 202 Happy Number 快乐数
  5. 日常记录-代码中Background后Padding 失效
  6. 掌握Spark机器学习库-07.6-线性回归实现房价预测
  7. OpenGL VAO, VBO 使用简介
  8. TensorFlow低阶API(一)—— 简介
  9. hystrix 解决服务雪崩效应
  10. Cannot find class: com.mysql.jdbc.driver