Yapi环境搭建及使用

前提准备

1.Docker&& Docker Compose
2.git clone https://github.com/fjc0k/docker-YApi.git

详细搭建教程

docker for Yapi Link

使用教程

官方文档: https://hellosean1025.github.io/yapi/

Link: 项目迁移 项目拷贝 数据Mock

mongoDB启动失败

使用 setenforce 0 解决

Spring MVC 项目单模块结合Yapi使用实例

IDEA Plugin Github: YapiIdeaUploadPlugin

官方教程 github Wiki

1..idea 文件夹下,找到misc.xml

<component name="yapi">
  <option name="projectToken">yapi 中项目tokenoption>
  <option name="projectId">yapi 中项目idoption>
  <option name="yapiUrl">http://127.0.0.1:3000option>
  <option name="projectType">apioption>
  <option name="attachUploadUrl">http://localhost/fileuploadoption>
  <option name="returnClass">com.project.Response(1.7.4 及之后才支持,按需配置)option>
component>

2.根据java doc tag 规范代码

①YAPI分类: Controller 添加 @menu

Example:
Yapi环境搭建及使用_第1张图片

对应Yapi项目中:
Yapi环境搭建及使用_第2张图片

②接口名称

Link Github Wiki

Maven Other Tag

            <plugin>
                <groupId>org.apache.maven.pluginsgroupId>
                <artifactId>maven-compiler-pluginartifactId>
                <configuration>
                    <source>1.8source>
                    <target>1.8target>
                configuration>
            plugin>
            <plugin>
                <groupId>org.apache.maven.pluginsgroupId>
                <artifactId>maven-jar-pluginartifactId>
                <configuration>
                    <archive>
                        <addMavenDescriptor>falseaddMavenDescriptor>
                    archive>
                configuration>
            plugin>
            
            <plugin>
                <groupId>org.apache.maven.pluginsgroupId>
                <artifactId>maven-source-pluginartifactId>
                <version>2.2.1version>
                <executions>
                    <execution>
                        <id>attach-sourcesid>
                        <goals>
                            <goal>jar-no-forkgoal>
                        goals>
                    execution>
                executions>
            plugin>
            
            <plugin>
                <groupId>org.apache.maven.pluginsgroupId>
                <artifactId>maven-javadoc-pluginartifactId>
                <version>3.1.0version>
                <configuration>
                    <tags>
                        <tag>
                            <name>menuname>
                            <placement>aplacement>
                            <head>所属菜单 -> Yapi Upload Plugin中对应着分类head>
                        tag>
                        <tag>
                            <name>descriptionname>
                            <placement>aplacement>
                            <head>描述 -> Yapi Upload Plugin中对应着标题head>
                        tag>
                        <tag>
                            <name>othername>
                            <placement>aplacement>
                            <head>除了description外的描述head>
                        tag>
                        <tag>
                            <name>datename>
                            <placement>aplacement>
                            <head>日期 2019/12/16 19:18head>
                        tag>
                        <tag>
                            <name>createdname>
                            <placement>aplacement>
                            <head>创建人head>
                        tag>
                        <tag>
                            <name>returnname>
                            <placement>aplacement>
                            <head>函数返回值head>
                        tag>
                    tags>
                configuration>
                <executions>
                    <execution>
                        <id>attach-javadocsid>
                        <goals>
                            <goal>jargoal>
                        goals>
                    execution>
                executions>
            plugin>

你可能感兴趣的:(小工具)