频道栏目
首页 > 程序开发 > 综合编程 > 其他综合 > 正文
我的第一个netcore2.2 api项目搭建(二) - sy2015 - 博客园
2019-05-09 14:36:29         来源:sy2015  
收藏   我要投稿

我的第一个netcore2.2 api项目搭建(二)

上一章快速使用SqlSugar搭建了netcore api项目,我的第一个netcore2.2 api项目搭建(一)

这一章实现目标二:api使用Swagger,实现api文档管理

效果图:第一张收缩,第二张展开,共有2个控制器:values和Account;控制器有注释,api有注释,实体有注释

\

<喎"/kf/ware/vc/" target="_blank" class="keylink">vcD4KPHA+PHN0cm9uZz4xLjHM7bzTc3dhZ2dlctL908M8L3N0cm9uZz48L3A+CjxwPm51Z2V0y9HL96O6U3dhc2hidWNrbGUuQXNwTmV0Q29yZaOssLLXsDwvcD4KPHA+PGltZyBzcmM9"https://www.2cto.com/uploadfile/Collfiles/20190509/20190509134032431.png" alt="\" />

1.2在startup中注册swagger

\public void ConfigureServices(IServiceCollection services) { services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2); //添加api管理 // Register the Swagger generator, defining 1 or more Swagger documents services.AddSwaggerGen(options => { options.SwaggerDoc("v1", new Info { //Version = "v1", Title = "MyFirst API",//" API", //Description = "", //TermsOfService = "None", //Contact = new Contact //{ // Name = "", // Email = string.Empty, // Url = "" //}, //License = new License //{ // Name = "Use under LICX", // Url = "" //} }); // Set the comments path for the Swagger JSON and UI. var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); options.IncludeXmlComments(xmlPath, true); xmlPath = Path.Combine(AppContext.BaseDirectory, "JH.OPEMR.Model.xml"); options.IncludeXmlComments(xmlPath, true); }); } View Code

注意这段:

\

这段代码是添加注释,如果有多个文件注释,只要逐个添加就好了,不建议将xml合并,并且这个需要项目生成相应xml

\

1.3在Configure中启用swagger

\public void Configure(IApplicationBuilder app, IHostingEnvironment env) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); } //启用Swagger // Enable middleware to serve generated Swagger as a JSON endpoint. app.UseSwagger(); // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.), // specifying the Swagger JSON endpoint. app.UseSwaggerUI(options => { options.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); }); app.UseMvc(); } View Code

F5运行之前将启动页改成swagger

\

F5运行

\

ok,swagger添加完成。

but,我尝试添加了一个GetUsers方法。。。

\

\

swagger失败,该死api路由,很不好理解,还是改成这样吧

\

F5,变成这样,直观多了。。。

至此,swagger添加完毕

点击复制链接 与好友分享!回本站首页
相关TAG标签 - - 博客园
上一篇:.net mvc 迁移到 .netcore - menkj - 博客园
下一篇:C#配置文件configSections详解 - lxsh_wyan - 博客园
相关文章
图文推荐
点击排行

关于我们 | 联系我们 | 广告服务 | 投资合作 | 版权申明 | 在线帮助 | 网站地图 | 作品发布 | Vip技术培训 | 举报中心

版权所有: 红黑联盟--致力于做实用的IT技术学习网站