Api接口文档软件Showdoc

简介:

showdoc网站打开看着不起眼,但里面的内容相当的强大,重点说下特点

1:支持markdown语法(所有的api接口写作现在都支持这个吧,因为他现在太方便了)

2:支持多用户协作,你可以在项目下面随意添加多个用户一起完成api文档的写作。

3:可以分享并导出项目,生成需要的文档格式如doc,可以离线浏览

4:支持响应式,手机电脑同样精彩

5:支持项目转让

6:支持模版插入

7:支持历史版本,你可以把操作恢复到以前的版本。

8:showdoc完全开源

9:可以部署到自己的服务器

10:如果在线使用,可以设置自己的个性域名,也可以对文档进行加密,浏览者需要密码才能访问

11:可以通过一个在线测试api的工具,直接生成markdown,你几乎不用写代码就能过所有的参数自动生成

showdoc 部署安装http://blog.csdn.net/ly_dengle/article/details/70231276
参考showdoc部署手册http://blog.star7th.com/2016/05/2007.html
Composer安装
Composer 是 PHP 的一个依赖管理工具,功能上类似于Java 的 Maven,Python 的 pip,Ruby的 gem,Nodejs 的 npm。通过Composer,你可以通过几句命令行便可以下载安装好ShowDoc



     本文转自yzy121403725 51CTO博客,原文链接:http://blog.51cto.com/lookingdream/2073006,如需转载请自行联系原作者



相关文章
|
2月前
|
API
阿里云短信服务文档与实际API不符
阿里云短信服务文档与实际API不符
|
16天前
|
JSON 前端开发 API
后端开发中的API设计与文档编写指南####
本文探讨了后端开发中API设计的重要性,并详细阐述了如何编写高效、可维护的API接口。通过实际案例分析,文章强调了清晰的API设计对于前后端分离项目的关键作用,以及良好的文档习惯如何促进团队协作和提升开发效率。 ####
|
5月前
|
Java API 开发者
在Spring Boot中集成Swagger API文档
在Spring Boot中集成Swagger API文档
|
4月前
|
Java API 数据中心
百炼平台Java 集成API上传文档到数据中心并添加索引
本文主要演示阿里云百炼产品,如何通过API实现数据中心文档的上传和索引的添加。
108 3
|
5月前
|
安全 Java API
Nest.js 实战 (三):使用 Swagger 优雅地生成 API 文档
这篇文章介绍了Swagger,它是一组开源工具,围绕OpenAPI规范帮助设计、构建、记录和使用RESTAPI。文章主要讨论了Swagger的主要工具,包括SwaggerEditor、SwaggerUI、SwaggerCodegen等。然后介绍了如何在Nest框架中集成Swagger,展示了安装依赖、定义DTO和控制器等步骤,以及如何使用Swagger装饰器。文章最后总结说,集成Swagger文档可以自动生成和维护API文档,规范API标准化和一致性,但会增加开发者工作量,需要保持注释和装饰器的准确性。
136 0
Nest.js 实战 (三):使用 Swagger 优雅地生成 API 文档
|
5月前
|
开发框架 Java 测试技术
Spring Boot中的API文档生成
Spring Boot中的API文档生成
|
5月前
|
JSON 监控 API
ERP软件、应用商城以及上货软件的API接入方式各有其特点
ERP软件、应用商城以及上货软件的API接入方式各有其特点,但大体上遵循类似的流程。以下是对这些API接入方式的详细解析:
|
5月前
|
JSON Java API
Spring Boot中使用OpenAPI生成API文档
Spring Boot中使用OpenAPI生成API文档
|
5月前
|
缓存 Serverless API
函数计算产品使用问题之如何开通Stable Diffusion(SD)的API并在本地软件中调用
函数计算产品作为一种事件驱动的全托管计算服务,让用户能够专注于业务逻辑的编写,而无需关心底层服务器的管理与运维。你可以有效地利用函数计算产品来支撑各类应用场景,从简单的数据处理到复杂的业务逻辑,实现快速、高效、低成本的云上部署与运维。以下是一些关于使用函数计算产品的合集和要点,帮助你更好地理解和应用这一服务。
|
6月前
|
自然语言处理 安全 API
触发邮件接口有哪些?邮件API文档
**触发邮件接口**如AokSend、Mailgun、Amazon SES、Postmark和Sendinblue是自动化企业通信的关键。这些接口在特定事件时自动发送邮件,提高效率和客户体验。例如,AokSend提供详细的API文档,支持事件触发、模板管理和多语言集成;Mailgun以灵活性著称;Amazon SES适合大规模发送;Postmark专注于事务邮件;Sendinblue则提供邮件、短信和营销自动化功能。每种服务都有示例代码展示如何使用API发送邮件。选择合适的接口能提升企业通信效率和客户满意度。