using System;  using System.Linq;  using System.Web;  using System.Web.Http;  using System.Web.Security;    namespace OtherApi.Auth  {        public class AuthFilterOutside : Authori
原创 2021-07-09 17:09:24
116阅读
using System;   using System.Linq;   using System.Web;   using System.Web.Http;   using System.Web.Security;   namespace OtherApi.Auth   {       public class AuthFilterOutside : AuthorizeAttri
转载 2022-02-28 11:18:25
202阅读
一、前言 上篇有提到在WebAPI项目内,通过在Nuget里安装(Microsoft.AspNet.WebApi.HelpPage)可以根据注释生成帮助文档,查看代码实现会发现是基于解析项目生成的xml文档来作为数据源从而展示出来的。在我们的项目帮助文档需要的类(特指定义的Request和Respo
原创 2021-08-11 15:33:38
267阅读
在vs2015 里面生成WebAPI项目 默认包含一个自动生成API说明文档的功能. 但是里面的方法注释和文档注释默认是不存在的. 百度了一下, 找到了解决方法. 生成的效果如下.首先要配置项目可以生成XML说明文档.. 右击你的项目->生成->输出->勾上 XML文档文件 然后把这个文件名放在下面的代码里.然后 在Areas/HelpPage/App_Start/HelpPageC
原创 2021-09-03 09:48:51
157阅读
.
转载 2015-05-30 15:23:00
46阅读
2评论
 最近做的项目使用mvc+webapi,采取前后端分离的方式,后台提供API接口给前端开发人员。这个过程中遇到一个问题后台开发人员怎么提供接口说明文档给前端开发人员,最初打算使用word文档方式进行交流,实际操作中却很少动手去写。为了解决这个问题,特意在博客园中搜索了一下api接口文档生成的文章,引起我注意的有两种方案。 1.微软自带的Microsoft.AspNet.WebApi.HelpPa
原创 2021-07-16 15:17:05
567阅读
最近做的项目使用mvc+webapi,采取前后端分离的方式,后台提供API接口给前端开发人员。这个过程中遇到一个问题后台开发人员怎么提供接口说明文档给前端开发人员,最初打算使用word文档方式进行交流,实际操作中却很少动手去写。为了解决这个问题,特意在博客园中搜索了一下api接口文档生成的文章,引起
原创 2022-12-13 21:18:52
302阅读
一、问题 使用Swashbuckle.AspNetCore生成.NetCore WEBAPI的接口文档的方法 二、解决方案 参考文章:https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/web-api-help-pages-using-swa
转载 2019-07-05 15:24:00
67阅读
2评论
注意点: 1.mvc的控制器必须继承于ApiController,否则看不到的 2. 简单查看xml,根据第二步即可生成xml,可视感比较低,但是内容全部有,不限定于Api 一、设置 二、打开帮助文档子项目的配置文件,解开红框标注的配置项,并把文件路径设置成跟上面项目生成配置的一样 三、在指定路径下 ...
转载 2021-10-09 13:30:00
187阅读
2评论
一:安装Swagger搜Swashbuckle.AspNetCore在NuGet中,安装Swashbuckle.AspNetCore:我使用的版本为:5.0.0-rc2二:引入Swagger功能Ⅰ:Startup.cs①,ConfigureServices方法中:publicvoidConfigureServices(IServiceCollectionservices){services.Add
原创 2019-09-19 16:34:24
8811阅读
注意点: 1.mvc的控制器必须继承于ApiController,否则看不到的 2. 简单查看xml,根据第二步即可生成xml,可视感比较低,但是内容全部有,不限定于Api 一、设置 二、打开帮助文档子项目的配置文件,解开红框标注的配置项,并把文件路径设置成跟上面项目生成配置的一样 三、在指定路径下 ...
转载 2021-10-09 13:30:00
115阅读
2评论
Swagger2Md:让WebAPI文档生成变得轻松高效在当今数字化时代,WebAPI的开发与使用日益频繁。如何让他人更便捷地调用我们编写的基于OpenAPI 3.0规范的WebAPI呢?Swagger2Md应运而生,它能够将swagger.json转化为清晰易读的markdown文档,极大地简化了文档编写流程。功能特性文档转换:将swagger.json生成markdown文档,方便在各种支持m
原创 5月前
38阅读
最近做的项目使用mvc+webapi(非.Net Core),采取前后端分离的方式,后台提供API接口给前端开发人员。这个过程中遇到一个问题后台开发人员怎么提供接口说明文档给前端开发人员,最初打算使用word文档方式进行交流,实际操作中却很少动手去写。为了解决这个问题,特意在博客园中搜索了一下api
转载 2019-01-09 16:26:00
452阅读
2评论
1、  在NuGet中搜索 Swashbuckle2、  安装Swashbuckle3、  Swashbuckle 是通过生成的XML文件来读取注释的,生成 SwaggerUI,JSON 配置中的说明的,安装时会在项目目录 App_Start 文件夹下生成一个 SwaggerConfig.cs 配置文件,用于配置 SwaggerUI 相关展示行为的。如图:将配置文件第
原创 2016-03-09 17:31:58
1448阅读
1.创建 API 帮助页 2.将帮助页添加到现有的项目 3.添加Api文档 4.Under the Hood 当你创建一个网络 API 时,它很有用来创建一个帮助页,以便
转载 2016-07-06 17:17:00
83阅读
2评论
Java利用开发中代码生成工具的作用近来,随着各种代码生成工具的不断涌现(如SpringSource的Spring Roo、Skyway Builder Community Edition 6.3及Blu Age的M2Spring等),人们又将留心力转移到了这些代码生成工具在企业级Java使用开发中所起的作用。模型驱动开发(MDD)正取得越来越多的重视,而在一个典型的Java使用中有些内容完全是可
JApiDocs是一个无需额外注解、开箱即用的SpringBoot接口文档生成工具。编写和维护API文档这个事情,对于后端程序员来说,是一件恼人但又不得不做的事情,我们都不喜欢写文档,但除非项目前后端代码都是自己写的,否则API文档将是前后端协作中一个不可或缺的沟通界面。既然不可避免,那就想办法弄个轮子吧。人生苦短,必须偷懒。无图无真相,生成文档的效果如下: 相比Swagger要写一堆注解,Sp
转载 2023-09-22 09:00:39
235阅读
1. Swagger是什么? Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。Swagger 让部署管理和使
转载 2019-01-09 16:20:00
320阅读
2评论
问题由来:开发个新需求,需要按规定导出word文档文档截图如下  因为之前没做过这个,一脸懵B啊,导出excel和txt倒是经常接触到,对于这个word这种格式不严谨的文件怎么处理呢? 技术选型:可协助实现的技术很多,但是本人极力推荐freemarker,简直太好用了。 具体实施:步骤一:maven项目 先添加如下依赖:<!--freemarker
如果应用程序需要动态生成 PDF 文档,则需要 iText 库。开放源码的 iText 库使 PDF 文档的创建能够在瞬间完成。本文介绍了 iText 并提供了使用它从 Java ? 技术应用程序生成 PDF 文档的由浅入深的指南。我们创建了一个示例应用程序以更好地理解 iText。很多应用程序要求动态生成 PDF 文档。这类应用程序包括银行生成用于电子邮件投递的客户报表,到读者购买特定图书章节并
  • 1
  • 2
  • 3
  • 4
  • 5