smart-doc+torna搭建企业级接口管理系统

torna搭配smart-doc搭建企业级接口管理系统

torna

配置数据库

• 在数据库中新建名为torna的数据库，并创建torna用户权限

  # 新建数据库
  CREATE DATABASE `torna` CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_0900_ai_ci'
  
  # 创建用户
  CREATE USER 'torna'@'%' IDENTIFIED BY 'passwd';
  
  # 给用户赋予数据库权限
  GRANT ALL PRIVILEGES ON torna.* TO 'torna'@'%';
  
  # 刷新权限
  FLUSH PRIVILEGES;

• 创建表，构建脚本从mysql.sql下载。

下载镜像

docker pull tanghc2020/torna

启动

docker run --name torna --restart=always \
  -p 7700:7700 \
  -e JAVA_OPTS="-Xms256m -Xmx256m" \
  -e MYSQL_HOST="192.168.0.1:3306" \
  -e MYSQL_SCHEMA="torna" \
  -e MYSQL_USERNAME="torna" \
  -e MYSQL_PASSWORD='passwd' \
  -e torna.jwt.secret="jwtsecret"
  -d tanghc2020/torna

登录

访问localhost:7700 查看是否正常，默认账号密码 admin 123456

获取token

登录后创建空间-项目-模块，在OpenAPI中获取到token复制备用。

smart-doc

以gradle配置为例

添加并配置gradle插件

plugins {
    id 'org.springframework.boot' version '2.6.4'
    id 'io.spring.dependency-management' version '1.0.11.RELEASE'
    id "com.github.shalousun.smart-doc" version "2.4.0"
    id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'

configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
}

repositories {
    mavenLocal()
    maven { url 'https://maven.aliyun.com/repository/public' }
    mavenCentral()
}

dependencies {
    implementation('org.springframework.boot:spring-boot-starter-web')
    
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'
}


tasks.named('test') {
    useJUnitPlatform()
}

smartdoc {
    configFile = file("src/main/resources/smart-doc.json")
    // include 'com.baomidou:mybatis-plus-extension' //如果添加了mybatis plus
}

配置smart-doc.json

{
  "isStrict": false,
  "pathPrefix": "/",//是否开启严格模式
  "outPath": "doc",  //指定文档的输出路径,maven插件不需要，gradle插件必须
  "packageFilters": "",  //controller包过滤，多个包用英文逗号隔开
  "projectName": "test",  //配置自己的项目名称
  "appToken": "上面获取到的token",//torna平台appToken,@since 2.0.9
  "openUrl": "http://localhost:7700/api",  //torna平台地址，填写自己的私有化部署地址@since 2.0.9
  "debugEnvName": "测试环境",  //torna测试环境
  "replace": true,  //推送torna时替换旧的文档
  "debugEnvUrl": "http://127.0.0.1",  //torna

  inlineEnum":true //设置为true会将枚举详情展示到参数表中，默认关闭，//@since 1.8.8版本开始
}

根据实际情况修改

推送接口文档