无入侵接口文档smart-doc

这篇具有很好参考价值的文章主要介绍了无入侵接口文档smart-doc。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

Smart-doc优点:

1.非侵入式生成接口文档
2.减少接口文档的手动更新麻烦&保证了接口文档和代码的一致
3.随时可生成最新的接口文档
4.保持团队代码风格一致:smart-doc支持javadoc,必须按照这个才能生成有注释的接口文档

最终效果

无入侵接口文档smart-doc,java

1.导入依赖

               <plugin>
                <groupId>com.github.shalousun</groupId>
                <artifactId>smart-doc-maven-plugin</artifactId>
                <version>2.2.7</version>
                <configuration>
                    <configFile>./src/main/resources/smart-doc.json</configFile>
                    <projectName>Smart-Doc初体验</projectName>
                </configuration>
            </plugin>

2.在resources下新建smart-doc.json

无入侵接口文档smart-doc,java

{
  "serverUrl": "http://127.0.0.1:8081",
  "packageFilters": "com.demo.controller.DemoController",
  "isStrict": false,
  "allInOne": true,
  "outPath": "src/main/resources/static/doc",
  "projectName": "smart-doc"
}

3.复制到smart-doc.json

无入侵接口文档smart-doc,java

4.直接打开index.html

http://localhost:63342/demo/static/doc/index.html?_ijt=9d6ajticc8vm2ckffmddok81hj
无入侵接口文档smart-doc,java文章来源地址https://www.toymoban.com/news/detail-688015.html

到了这里,关于无入侵接口文档smart-doc的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • swagger-bootstrap-ui 报错No mapping for GET /doc.htm,404l,以及无法显示接口文档

    首先是访问http://ip:/doc.htmlhttp://${host}:${port}/doc.htmlhttp://ip:/doc.html报错 1、假如是SpringSecurity项目,可能是configure(WebSecurity web)没有放行,代码如下 在启动类中修改成如下代码 Swagger配置类 Controller类  Swagger依赖

    2024年02月13日
    浏览(44)
  • Java处理doc类型的Word文档转换成html(按顺序保留格式+图片)

    最新有个新需求,就是doc文档转换html内容倒不是很难,给大家分享一下,总体思路就是按doc转html的思路来走,唯一缺点是不会自动转换图片,图片是要手动转成base64,默认是有html、body、head、meta等等标签,我这里都用正则处理掉了。 需要注意的是: .docx 格式的 Word 文档是

    2024年02月03日
    浏览(88)
  • es创建索引库bug。Failed to parse mapping [_doc]: analyzer [ik_smart] has not been configured in mappings

    前提:                 出现这个bug是因为在Linux端使用docker-compose 部署好es后没有在plugins目录下配置好ik分词器,导致在es管理开发工具端,使用带有ik_smart分词的配置进行索引库创建映射导致的bug!             解决方案:                 在Linux端的es部署目录下创建plugins配件

    2024年02月04日
    浏览(48)
  • 如何将doc格式文档转换为txt的文档

    今天的办公环境中,我们常常会遇到需要将doc格式的文档转换为txt格式的文档的情况。这种情况下,我们需要一些便捷的工具来帮助我们解决这个问题。下面,我将向大家介绍三种将doc格式的文档转换为txt格式的文档的方法。 第一种方法是使用在线文档转换工具、APP。目前,

    2024年02月06日
    浏览(72)
  • Java技术-接口文档-Swagger2&Swagger3&接口文档UI整合

    目录 一、Swagger2完整用法 1.POM依赖 2.接口类 3.实现类 4.托管静态资源 5.接口文档配置 6.生产环境关闭接口文档 7.Swagger3页面效果 二、Swagger3完整用法 三、Swagger整合Knife4jUi 1.POM依赖 2.接口类 3.实现类 4.托管静态资源 5.接口文档配置 6.生产环境关闭接口文档 四、注释和参数讲解

    2024年02月16日
    浏览(49)
  • Snort开源入侵防御系统部署文档(一)

    (个人操作记录,不喜勿喷,水平低下,见谅见谅) Snort 是世界上最重要的开源入侵防御系统 (IPS)。 Snort IPS 使用一系列规则来帮助定义恶意网络活动,并使用这些规则来查找与其匹配的数据包并为用户生成警报。Snort 也可以内联部署来阻止这些数据包。 Snort 有三个主要

    2024年02月22日
    浏览(42)
  • django rest_framework 部署doc文档

    1.背景    在实际开发过程中,前后端分离的项目,是需要将一份完整的接口文档交付给前端开发人员,这样有利于开发速度和开发质量,以及有可能减少协同时间。 2.内容   本项目是以Python+django+rest_framework作为技术框架,在这套框架中,是有自己支持的api文档,现将实现方

    2024年01月17日
    浏览(47)
  • 前端js react vue怎么实现在线预览doc文档

    先说结论: 目前在纯前端层面没有很好的方案,基本都需要服务端的介入。 优点 :简单易用,无需配置 缺点 :文档需要支持外网访问,且文档会是公开可见的,所以对于一些内部敏感的文档来说,这个显然是不可行的。 需要后端介入配合 onlyoffice地址 这个也要先在服务器

    2024年02月15日
    浏览(85)
  • 怎样查询 elasticsearch es doc 文档中的 version 版本号

    参考链接:https://stackoverflow.com/questions/39016589/how-to-get-the-docs-version-field 记录一下: 需要加一个 version=true 的参数,返回结果中就会返回 version 。 返回结果:

    2024年02月16日
    浏览(41)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包