ZzApiDoc-接口文档管理工具(持续更新,欢迎体验)

最新推荐文章于 2024-11-17 15:49:27 发布

weixin_34362790

最新推荐文章于 2024-11-17 15:49:27 发布

阅读量660

点赞数

文章标签：移动开发 javascript java ViewUI

原文链接：https://juejin.im/post/5a6f2a63518825732d7fdf83

版权

ZzApiDoc

项目托管地址：github.com/zhouzhuo810…

本文主要介绍【小周接口文档在线管理工具-服务+Web端】

关于【Android客户端】ZzApiDoc-Android功能：后续再详细介绍;

ZzApiDoc在线演示地址

开发工具

InteliJ IDEA 2017.1.2
基于SpringMVC+Bootstrap+jQuery开发

功能简介

项目管理;
接口分组管理;
接口管理;
请求参数管理;
返回参数管理;
全局错误码管理;
PDF文档导出;
Android RxJava+Retrofit2+OkHttp3接口调用代码和实体类代码下载;

生成文档示例

生成实体类代码

package com.example.zzapidoc.common.api.entity;

import java.util.List;
/**
 * 用户登录
 */
public class UserLoginResult {
       private String code;  //
       public void setCode(String code) {
           this.code = code;
       }
       public String getCode() {
           return code;
       }
       private String msg;  //
       public void setMsg(String msg) {
           this.msg = msg;
       }
       public String getMsg() {
           return msg;
       }
}
复制代码

package com.example.zzapidoc.common.api;

import retrofit2.http.*;
import rx.Observable;
import com.example.zzapidoc.MyApplication;
import com.example.zzapidoc.common.api.entity.*;


/**
 * 默认分组
 */
public interface Api0 {
   /*
    * 用户登录()
    */
   @FormUrlEncoded
   @POST("ZzApiDoc/v1/user/userLogin")
   Observable<UserLoginResult> userLogin(@Field("phone") String phone,@Field("password") String password);   
}
复制代码