swagger

我在WebApi中使用swagger的时候发现会出现很多问题，搜索很多地方都没找到完全解决问题的方法，后面自己解决了，希望对于遇到同样问题朋友有帮助。我将先一步一步的演示项目中解决swagger遇到问题及解决方法。 　　首先我们新建一个api项目 图1 （默认生成项目） 图2（运行首页） 图3（默认Api列表） 图4（默认Get的Api） 以上图1-4都是默认情况下生成页面看起来不是那么好看，而且测试也不方便，下面将介绍怎么使用swagger。 　　使用nuget包获取Swashbule、swagger的包并安装。 图5（Swashbule - swagger for Api） 图6（swagger UI for net） 一般安装到就应该可以正常运行了。但是运行后我们发现抛出异常 图7（异常1） 打开解决方案属性-->生成，勾选XML文档文件，保存就ok。 图8 图9（异常2） 出现该异常是由于没有增加依赖项，大家可以自行查看自己的dll文件版本，做出修改，把下面的代码插入到web.config中。 1 2 3 4 5 6 7 8 9 10 11 12 <dependentAssembly> <assemblyIdentity name= "System.Net.Http.Formatting" publicKeyToken= "31bf3856ad364e35" culture

1.安装swagger包 2.startup里configservers Configure 3.可能出现的错误 提示error xxxxnot found 由于我创建的webapi是restful风格的所以当出现多个同类型的接口时会出错【其实就是找不到哪一个接口】 解决方法： a.在接口上指定路由，比如[Route("xxx")]或[httpget("xxx/xxx/{id}")] b.由于我实在是不喜欢restful的接口所以我在startup上指定了路由 app.UseEndpoints(endpoints => { endpoints.MapControllerRoute( name: "default", pattern: "{controller=WeatherForecast}/{action=Get}/{id?}"); }); 来源： https://www.cnblogs.com/weiruanojbk/p/12355433.html

目录 Springboot集成Swagger2 一、Swagger2 阐述 二、Swagger2 基础使用 三、相关注解 四、注意事项 Springboot集成Swagger2 一、Swagger2 阐述 Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。 作用： 1. 接口的文档在线自动生成。 2. 功能测试。 Swagger是一组开源项目，其中主要要项目如下： 1. Swagger-tools :提供各种与Swagger进行集成和交互的工具。例如模式检验、Swagger 1.2文档转换成Swagger 2.0文档等功能。 2. Swagger-core : 用于Java/Scala的的Swagger实现。与JAX-RS(Jersey、Resteasy、CXF...)、Servlets和Play框架进行集成。 3. Swagger-js : 用于JavaScript的Swagger实现。 4. Swagger-node-express : Swagger模块，用于node.js的Express web应用框架。 5. Swagger-ui ：一个无依赖的HTML、JS和CSS集合

swagger入门： 转载至: https://www.jianshu.com/p/0e498041f882 swagger-ui 3升级 转载至: https://www.ibm.com/developerworks/cn/java/j-using-swagger-in-a-spring-boot-project/index.html 来源： https://www.cnblogs.com/xiejunjun-rhino/p/12335254.html

Swagger的基础入门 Swagger包括Swagger Editor， Swagger UI等很多部分，这里我们主要讲一下Swagger Editor。它是一个完全开源的项目，并且它也是一个基于Angular的成功案例。 在Swagger Editor中，我们可以基于YAML等语法定义我们的RESTful API，然后它会自动生成一篇排版优美的API文档，并且提供实时预览。简单说就是可以边编写API 边预览边测试。 在Swagger UI中，我们不能进行编写API ，但是我们可以预览或者测试。 安装Swagger editor Node.js 安装 node中 http-server安装 npm install http-server 下载swagger-editor 从官网下载swagger-editor.zip，解压即可。 https://swagger.io/ 启动swagger-editor http-server E:\swagger-editor-master\swagger-editor-master 当出现以下提示，则证明成功了。 使用浏览器访问 http://127.0.0.1:8081 界面左边是api 文件的 yaml 描述文件， 左边部分可以直接编辑API文档，编辑会立即更新到右边视图。右边是swagger-UI，可以查看文档，并直接进行API的测试。