首页 > 其他分享 >怎样在Apipost中设计出实用又好看的API文档

怎样在Apipost中设计出实用又好看的API文档

时间:2023-08-02 17:46:33浏览次数:30  
标签:Mermarid Apipost 插入 API 文档 Markdown

Apipost一直推荐文档先行的API设计理念,在Apipost中可以添加Markdown格式的文本,用以储备文档和API文档设计。
作为一种轻量级标记语言,Markdown在撰写文档、博客文章、README文件以及网站内容上被广泛使用。

如何在Apipost中设计出漂亮的文档?

Apipost近期发布的7.1.9版本更新中,Apipost Markdown文本喜提功能更新~

「新增7种颜色的高亮块展示、五种告示方式、折叠块、各种Mermarid图表(流程图、时序图等)」

 

 

合理利用这些图表,漂亮的文档信手拈来!~

小编这里以一个简单登录接口文档来展示更新后的Apipost Markdown有什么不同~

01.高亮块&告示块

推荐使用高亮块展示代码片段,通过选择合适的颜色,使代码更加醒目。还可以使用告示方式,例如警告、提示等,来突出重要信息。通过在编辑器中插入或输入下方语法:

 

 

02.折叠块

折叠块功能可以帮助我们组织文档结构,将一些内容进行折叠隐藏,使得文档加清晰易读。折叠块语法:

 

 

03.表格

请求参数可以通过插入表格展示:

 

 

04.响应结果

响应结果插入代码块后的实时预览:

 

 

05.Mermarid图表

Apipost 支持插入流程图、时序图、类图等 Mermarid 图表。你可以使用 Mermarid 的语法来创建这些图表,并将其插入到文档中。

例如:登录接口流程图:使用 Mermarid 的语法或直接在Apipost中插入创建流程图表:

 

标签:Mermarid,Apipost,插入,API,文档,Markdown
From: https://www.cnblogs.com/meimaodachong/p/17601338.html

相关文章

  • SpringCloudAlibaba Gateway聚合knife4j接口文档
    实现效果:Gateway服务可以查看多个服务的接口文档; knife4j依赖:<dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-spring-boot-starter</artifactId><version>3.0.3</versio......
  • WebApi接口的调用和传参
    publicCommon.mdlResultModel<mdlGetHistoryData>GetHistoryDataByCondition(intpDeviceId,intpPageIndex,intpPageSize,stringpStartTime,stringpEndTime)       {           Common.mdlResultModel<mdlGetHistoryData>objResult=newCommon.m......
  • 多语言演示API接口对接电商平台,优惠券查询源代码演示示例
     优惠券查询API接口的重要性可以从以下几个方面来说明:优惠券信息获取:优惠券查询API接口可以提供用户和开发者获取优惠券的详细信息,包括优惠券名称、类型、面值、使用规则、有效期等。这些信息对于用户来说非常重要,可以帮助他们选择适合自己的优惠券,并充分利用优惠券的优惠力度。优......
  • Asp.net Web Api .net6如何解决跨域的问题
    在Program.cs中添加如下代码//配置跨域builder.Services.AddCors(cor=>{varcors=builder.Configuration.GetSection("CorsUrls").GetChildren().Select(p=>p.Value);cor.AddPolicy("Cors",policy=>{policy.WithOrigins(c......
  • 处理API请求并行问题
    背景:我们有一个导出全部数据的功能,因为各种原因,可能需要同时发送10几条请求来获取数据遇到的问题:因为浏览器http/1.1最多同时进行6个请求,所以会阻塞用户的其他操作打个比喻:之前我们是一个赛道,可以上6个任意国家的运动员,第七个人想上去就得排队现在改为了两个赛......
  • .Net Web API 004 Controller获取对象列表,传入数据以及对象
    1、返回UserEntityList这个服务接口的目的是分为用户列表,代码如下所示。///<summary>///得到用户列表///</summary>///<returns></returns>[HttpGet][Route("GetUserList")]publicActionResult<List<UserEntity>>GetUserList(){varmyUse......
  • rest-apiV2.0.0升级为simplest-api开源框架生态之simplest-jpa发布
    什么是simplestsimplest追求存粹简单和极致。旨在为项目快速开发提供一系列的基础能力,方便用户根据项目需求快速进行功能拓展不在去关心一些繁琐。重复工作,而是把重点聚焦到业务。前言程序10年。作为一个多年程序。深知每个项目和程序,都有很多重复性工作要做。入行近10......
  • 台积电迎新劲敌,Rapidus横空杀出欲抢2纳米客户 | 百能云芯
    8月2日消息,据台媒报道,台积电2纳米制程劲敌不只大家熟知的三星、英特尔,后面还有追兵,日本芯片国家队Rapidus也计划于2027年量产2纳米芯片,抢台积电客户。值得关注的是,英特尔上周财报会议上也放话,2025年用2纳米、1.8纳米从台积电手中拿回制程技术龙头地位,分析师透露,台积电内部相当紧张......
  • 干掉 CRUD!这个API开发神器效率爆炸,无需定义MVC类!!
    简介magic-api能够只通过UI界面就能完成简单常用的接口开发,能够支持市面上多数的关系性数据库,甚至还支持非关系性数据库MongoDB。通过 magic-api 提供的UI界面完成接口的开发,自动映射为HTTP接口,无需定义Controller、Service、Dao、Mapper、XML、VO等Java对象和相关文......
  • 干掉 CRUD!这个API开发神器效率爆炸,无需定义MVC类!!
    简介magic-api能够只通过UI界面就能完成简单常用的接口开发,能够支持市面上多数的关系性数据库,甚至还支持非关系性数据库MongoDB。通过 magic-api 提供的UI界面完成接口的开发,自动映射为HTTP接口,无需定义Controller、Service、Dao、Mapper、XML、VO等Java对象和相......