spring boot开发接口api

spring boot开发接口api

​ 在上一次教了大家怎么去搭建一个自己的后端模板之后，现在和大家分享讨论一下如何开发RestfulApi接口。
首先开发api之前要考虑到后端是需要写api文档的，这里可以提两个比较好的在线自动生成api文档的工具：swagger和showdoc。当然还有其他好的工具，大家可以去自己探索，但是希望在开发接口之前就确定好使用哪一种工具，使用之后就不要再去考虑其他的工具了，不然会耽误开发。在这里我个人比较喜欢showdoc生成的文档格式，清晰明了，但是用它生成的文档代码量比较大，swagger相对来说代码量比showdoc少一点，但是生成的文档没有showdoc那么好看。showdoc基本上不需要什么配置，swagger需要的配置比较麻烦。萝卜青菜各有所爱，看自己喜欢哪一个吧。

在这里我只讲开发接口api而已.

定义一个统一的响应模板

​ 开发出来的接口返回的响应结果应该尽可能的规范统一，可以去看restful规范来开发自己的接口。一个比较好的响应规范应该要有状态码（code）、信息描述（msg）、数据（data）。

下面我展示一下自己的开发模板：

package org.csu.backdemo.utils;

import lombok.Data;

import java.io.Serializable;

//统一响应数据格式
@Data
public class Result implements Serializable {
   

    private int code;//200表示正常，非200表示异常
    private String msg;//结果返回的信息
    private Object data;//结果返回的数据


    //请求成功的响应
    public static Result success(Object data){
   
        return success(200,"请求成功",data);
    }

    //自定义成功相应的信息内容
    public static Result success(int code,Stri