用Swagger2markup匯出介面文件
前言
最近公司正好需要整理介面文件,就想把Swagger2的文件匯出來。
開始配置
pom.xml
<dependency>
<groupId>io.github.swagger2markup</groupId>
<artifactId>swagger2markup</artifactId>
<version>1.3.3</version>
<scope>test</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/commons-beanutils/commons-beanutils -->
<dependency>
<groupId>commons-beanutils</groupId>
<artifactId>commons-beanutils</artifactId>
<version>1.9.2</version>
<scope>test</scope>
</dependency>
使用單元測試生成文件
package com.asiainfo.aigov;
import java.net.URL;
import java.nio.file.Paths;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import io.github.swagger2markup.GroupBy;
import io.github.swagger2markup.Language;
import io.github.swagger2markup.Swagger2MarkupConfig;
import io.github.swagger2markup.Swagger2MarkupConverter;
import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
import io.github.swagger2markup.markup.builder.MarkupLanguage;
@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
public class Swagger2Test {
@Test
public void generateAsciiDocs() throws Exception {
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
.withMarkupLanguage(MarkupLanguage.MARKDOWN)
.withOutputLanguage(Language.ZH)
.withPathsGroupedBy(GroupBy.TAGS)
.withoutInlineSchema()
.build();
Swagger2MarkupConverter.from(new URL("http://localhost:8080/familydoctor-webapp/v2/api-docs"))
.withConfig(config)
.build()
// .toFolder(Paths.get("./docs"));
.toFile(Paths.get("./docs/api"));
}
}
結後語
生成的文件是md格式,可以放到有道雲筆記裡,再匯出為pdf或html,也可以用pandoc轉成word。
相關文章
- 騰訊文件怎樣匯出excel表格 騰訊文件如何匯出excelExcel
- mindmaster匯出markdown文件AST
- IText匯出Word文件
- 匯出Excel或word文件Excel
- 【ApiDoc】自動化匯出介面文件之HTML/Markdown/PDF實踐APIHTML
- 【匯出匯入】% 在匯入匯出中的應用。
- 資料泵匯出匯入資料標準文件
- 匯出類介面如何斷言
- 懶得寫文件,swagger文件匯出來不香嗎Swagger
- springboot整合restdocs輸出介面文件Spring BootREST
- 快速生成好看實用的介面文件
- 用 PostgreSQL 的 COPY 匯入匯出 CSVSQL
- 【實戰】通過 JS 將 HTML 匯出為 PDF 文件JSHTML
- 如何用Java語言優雅地匯出Word文件Java
- FreeMarker模版引擎實現匯出world文件到本地
- 在C++程式中匯出Word文件的方法(轉)C++
- 介面文件生成
- 【匯出匯入】匯出匯入 大物件物件
- SBDoc2.1.0釋出,新增了匯出到html文件的功能HTML
- 用GridView匯入匯出Excel,並列印GridViewViewExcel
- 用DBMS_STATS匯入匯出oracle統計資訊Oracle
- 介面測試--介面文件規範
- 常用介面文件模板
- 介面文件生成工具
- [phpword][laravel-admin]匯入文件轉html,並使用富文字編輯後匯出PHPLaravelHTML
- 用php把資料匯出excelPHPExcel
- 【匯出PDF-專案應用】
- 用開源 apidoc rap編寫php介面文件APIPHP
- Notadd 應用配置資料匯入匯出設計
- 金山文件怎麼匯出excel檔案 金山文件到處excel檔案的方法Excel
- springMVC整合swagger2來輸出介面文件SpringMVCSwagger
- Activity 流程模型匯入匯出-activity流程模型匯入匯出模型
- js匯出EXCELjs匯出EXCELJSExcel
- 小白折騰伺服器(八):用 Markdown 寫介面文件伺服器
- Mysql匯入&匯出MySql
- Mysql匯入匯出MySql
- doris匯入匯出
- eosjs 文件(Serialize介面)JS