精华内容
下载资源
问答
  • 接口文档

    千次阅读 2019-08-15 18:18:53
    接口文档 用户登录 接口功能 验证用户登录,用户名和密码是否正确 接口调用请求说明 HTTP请求方式 get URL “http://localhost:8080/T216_SSH/vue/userAction_login.action” 请求参数 参数 说明 ...

    接口文档

    用户登录

    接口功能
    验证用户登录,用户名和密码是否正确
    接口调用请求说明
    HTTP请求方式

    get

    URL

    http://localhost:8080/T216_SSH/vue/userAction_login.action

    请求参数

    参数 说明
    uname 登录的用户名,必填
    pwd 登录的密码,必填

    返回字段

    code 0或者1
    msg 登陆状态
    http://localhost:8080/Pro_ssh/user/user_login.action?uname=zs&&pwd=123

    数据示例
    用户名或者密码为空时

    data:
    	code:0
    	msg:"用户或者密码为空"
    result:
    	pwd:""
    	uname:""
    

    用户名或者密码错误时

    data:
    	code:0
    	msg:"用户或者密码错误"
    result:
    	pwd:"zs"
    	uname:"124"
    

    登陆成功

    data:
    	code1
    	msg:"登陆成功"
    result:
    	pwd:"zs"
    	uname:"123"
    

    用户注册

    接口调用请求说明
    HTTP请求方式

    HTTP请求方式

    get

    URL

    http://localhost:8080/Pro_ssh/user/user_reg.action

    数据示例

    {
    	"msg":"用户注册成功",
    	"code":1
    }
    

    请求参数

    参数 说明
    uname 登录的用户名,必填
    pwd 登录的密码,必填

    增加文章

    接口功能
    新增文章信息

    调用说明
    HTTP请求方式

    post

    URL

    http://localhost:8080/T216_SSH/vue/articleAction_add.action

    请求参数

    参数 说明
    title 文章标题,必填
    body 文章内容

    返回字段

    code 0或者1
    msg 新增成功 或者 新增失败

    数据示例

    data:
    	code: 1
    	msg: "新增成功"
    	result:164
    

    文章修改

    接口功能

    修改文章信息

    调用说明

    HTTP请求方式

    post

    URL

    http://localhost:8080/T216_SSH/vue/articleAction_edit.action

    请求参数

    参数 说明
    id 文章编号
    title 文章标题
    body 文章内容

    返回字段

    code 0或者1
    msg 修改成功 或者 修改失败

    数据示例

    data:
    	code: 1
    	msg: "修改成功"
    	result:164
    

    文章删除

    接口功能

    删除文章信息

    调用说明

    HTTP请求方式

    post

    URL

    http://localhost:8080/T216_SSH/vue/articleAction_del.action

    请求参数

    参数 说明
    id 文章编号

    返回字段

    code 0或者1
    msg 删除成功 或者 删除失败

    数据示例

    data:
    	code: 1
    	msg: "删除成功"
    

    文章查询

    接口功能:
    展示所有书籍数据
    调用说明
    HTTP请求方式

    get

    URL

    http://localhost:8080/T216_SSH/vue/articleAction_list.action

    请求参数 传了title就是进行模糊查

    参数 说明
    title 文章标题

    返回字段

    code 0或者1
    msg 操作成功
    pageBean page: 页数, rows: 页大小, total: 总数, pagination: 是否分页,maxPage:最大页数,parameterMap:请求参数,url:请求路径
    result 查询结果

    数据示例

    data:
    	code:1
    	msg:"操作成功"
    	pageBean:
    		maxPage:16
    		page:1
    		pagination:true
    		parameterMap:{title: Array(1), page: Array(1), rows: Array(1)}
    		rows:10
    		total:151
    		url:"http://localhost:8080/T216_SSH/vue/articleAction_list.action"
    		__proto__:Object
    	result:(10) [{…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, __ob__: Observer]
    
    展开全文
  • 接口模板 接口文档

    千次下载 热门讨论 2016-05-20 16:54:01
    接口模板 接口文档
  • SpringBoot整合Swagger2,再也不用维护接口文档了!

    万次阅读 多人点赞 2019-03-24 12:04:50
    前后端分离后,维护接口文档基本上是必不可少的工作。一个理想的状态是设计好后,接口文档发给前端和后端,大伙按照既定的规则各自开发,开发好了对接上了就可以上线了。当然这是一种非常理想的状态,实际开发中却很...

    前后端分离后,维护接口文档基本上是必不可少的工作。一个理想的状态是设计好后,接口文档发给前端和后端,大伙按照既定的规则各自开发,开发好了对接上了就可以上线了。当然这是一种非常理想的状态,实际开发中却很少遇到这样的情况,接口总是在不断的变化之中,有变化就要去维护,做过的小伙伴都知道这件事有多么头大!还好,有一些工具可以减轻我们的工作量,Swagger2就是其中之一,至于其他类似功能但是却收费的软件,这里就不做过多介绍了。本文主要和大伙来聊下在Spring Boot中如何整合Swagger2。

    工程创建

    当然,首先是创建一个Spring Boot项目,加入web依赖,创建成功后,加入两个Swagger2相关的依赖,完整的依赖如下:

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    

    Swagger2配置

    Swagger2的配置也是比较容易的,在项目创建成功之后,只需要开发者自己提供一个Docket的Bean即可,如下:

    @Configuration
    @EnableSwagger2
    public class SwaggerConfig {
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .pathMapping("/")
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.nvn.controller"))
                    .paths(PathSelectors.any())
                    .build().apiInfo(new ApiInfoBuilder()
                            .title("SpringBoot整合Swagger")
                            .description("SpringBoot整合Swagger,详细信息......")
                            .version("9.0")
                            .contact(new Contact("啊啊啊啊","blog.csdn.net","aaa@gmail.com"))
                            .license("The Apache License")
                            .licenseUrl("http://www.baidu.com")
                            .build());
        }
    }
    

    这里提供一个配置类,首先通过@EnableSwagger2注解启用Swagger2,然后配置一个Docket Bean,这个Bean中,配置映射路径和要扫描的接口的位置,在apiInfo中,主要配置一下Swagger2文档网站的信息,例如网站的title,网站的描述,联系人的信息,使用的协议等等。

    如此,Swagger2就算配置成功了,非常方便。

    此时启动项目,输入http://localhost:8080/swagger-ui.html,能够看到如下页面,说明已经配置成功了:

    在这里插入图片描述

    创建接口

    接下来就是创建接口了,Swagger2相关的注解其实并不多,而且很容易懂,下面我来分别向小伙伴们举例说明:

    @RestController
    @Api(tags = "用户管理相关接口")
    @RequestMapping("/user")
    public class UserController {
    
        @PostMapping("/")
        @ApiOperation("添加用户的接口")
        @ApiImplicitParams({
                @ApiImplicitParam(name = "username", value = "用户名", defaultValue = "李四"),
                @ApiImplicitParam(name = "address", value = "用户地址", defaultValue = "深圳", required = true)
        }
        )
        public RespBean addUser(String username, @RequestParam(required = true) String address) {
            return new RespBean();
        }
    
        @GetMapping("/")
        @ApiOperation("根据id查询用户的接口")
        @ApiImplicitParam(name = "id", value = "用户id", defaultValue = "99", required = true)
        public User getUserById(@PathVariable Integer id) {
            User user = new User();
            user.setId(id);
            return user;
        }
        @PutMapping("/{id}")
        @ApiOperation("根据id更新用户的接口")
        public User updateUserById(@RequestBody User user) {
            return user;
        }
    }
    

    这里边涉及到多个API,我来向小伙伴们分别说明:

    1. @Api注解可以用来标记当前Controller的功能。
    2. @ApiOperation注解用来标记一个方法的作用。
    3. @ApiImplicitParam注解用来描述一个参数,可以配置参数的中文含义,也可以给参数设置默认值,这样在接口测试的时候可以避免手动输入。
    4. 如果有多个参数,则需要使用多个@ApiImplicitParam注解来描述,多个@ApiImplicitParam注解需要放在一个@ApiImplicitParams注解中。
    5. 需要注意的是,@ApiImplicitParam注解中虽然可以指定参数是必填的,但是却不能代替@RequestParam(required = true),前者的必填只是在Swagger2框架内必填,抛弃了Swagger2,这个限制就没用了,所以假如开发者需要指定一个参数必填,@RequestParam(required = true)注解还是不能省略。
    6. 如果参数是一个对象(例如上文的更新接口),对于参数的描述也可以放在实体类中。例如下面一段代码:
    @ApiModel
    public class User {
        @ApiModelProperty(value = "用户id")
        private Integer id;
        @ApiModelProperty(value = "用户名")
        private String username;
        @ApiModelProperty(value = "用户地址")
        private String address;
        //getter/setter
    }
    

    好了,经过如上配置之后,接下来,刷新刚刚打开的页面,可以看到如下效果:

    在这里插入图片描述

    可以看到,所有的接口这里都列出来了,包括接口请求方式,接口地址以及接口的名字等,点开一个接口,可以看到如下信息:

    在这里插入图片描述

    可以看到,接口的参数,参数要求,参数默认值等等统统都展示出来了,参数类型下的query表示参数以key/value的形式传递,点击右上角的Try it out,就可以进行接口测试:

    在这里插入图片描述

    点击Execute按钮,表示发送请求进行测试。测试结果会展示在下面的Response中。

    小伙伴们注意,参数类型下面的query表示参数以key/value的形式传递,这里的值也可能是body,body表示参数以请求体的方式传递,例如上文的更新接口,如下:

    在这里插入图片描述

    当然还有一种可能就是这里的参数为path,表示参数放在路径中传递,例如根据id查询用户的接口:

    在这里插入图片描述

    当然,除了这些之外,还有一些响应值的注解,都比较简单,小伙伴可以自己摸索下。

    在Security中的配置

    如果我们的Spring Boot项目中集成了Spring Security,那么如果不做额外配置,Swagger2文档可能会被拦截,此时只需要在Spring Security的配置类中重写configure方法,添加如下过滤即可:

    @Override
    public void configure(WebSecurity web) throws Exception {
        web.ignoring()
                .antMatchers("/swagger-ui.html")
                .antMatchers("/v2/**")
                .antMatchers("/swagger-resources/**");
    }
    

    如此之后,Swagger2文件就不需要认证就能访问了。不知道小伙伴们有没有看懂呢?有问题欢迎留言讨论。
    关注公众号【江南一点雨】,专注于 Spring Boot+微服务,定期视频教程分享,关注后回复 Java ,领取松哥为你精心准备的 Java 干货!

    展开全文
  • 接口文档编辑工具+接口文档编写

    千次阅读 2020-03-05 19:12:03
    接口文档编辑工具 参考@Lucky锦【接口文档编辑工具】 Swagger: 通过固定格式的注释生成文档. 省时省力,不过有点学习成本。https://swagger.io/ eoLinkerhttps://www.eolinker.com/#/ ShowDoc(我使用的是这个,...

    目录

    接口文档编辑工具

    接口文档编写

    补充

    GET与POST的区别


    接口文档编辑工具

    参考@Lucky锦【接口文档编辑工具】

    Swagger:
    通过固定格式的注释生成文档. 省时省力,不过有点学习成本。
    https://swagger.io/

    eoLinker
    https://www.eolinker.com/#/

    ShowDoc(我使用的是这个,制作的效果不错。里面也有一些接口文档示例,可以参考)
    https://www.showdoc.cc/

    初始界面 

    选项 

     

    示例模板 

     

     

    接口文档编写

    参考@qq_41961113【正确规范写接口文档】@东东427【接口文档应该如何编写】

     

    补充

    GET与POST的区别

    @大宽宽【GET 和 POST 到底有什么区别?】

     

     

    展开全文
  • 支付宝开发接口文档及案例

    千次下载 热门讨论 2015-06-28 23:31:35
    支付宝开发接口文档 案例 帮助您快速上手
  • 提供一些我自己使用过的api数据接口,让学习前端的朋友可以提早熟练地调用一些Api...点击查看文档,就可以进入接口文档的详细使用步骤了。 这个接口很适合喜欢音乐的朋友去打造属于自己的音乐主页 第二个: 黑马...

    提供一些我自己使用过的api数据接口,让学习前端的朋友可以提早熟练地调用一些Api接口。

    以下api数据接口主要为一些学过ajax或一些学过vue基础的同学。
    第一个:网易云音乐的api数据接口,
    基础访问地址(api的跟地址)为:https://autumnfish.cn/在这里插入图片描述
    点击查看文档,就可以进入接口文档的详细使用步骤了。
    在这里插入图片描述
    第二个音乐接口文档;QQ音乐接口文档
    QQ音乐接口文档地址(api接口跟地址):https://rain120.github.io/qq-music-api
    网页效果:
    在这里插入图片描述
    在这里插入图片描述

    这两个接口很适合喜欢音乐的朋友去打造属于自己的音乐主页

    第三个: 黑马优购的电商文档(里面内容有点小问题,但不影响使用),适合电商网页的开发,更适合一些电商小程序和uni-app项目的搭建。博主已经完成咯哟!
    接口地址:https://www.showdoc.cc/128719739414963?page_id=2516997897914014
    页面效果:在这里插入图片描述
    对于以及学过全部vue的知识,或者了解一定的npm知识,可以去github去下载一些用node写的api接口,装个phpstudy,然后在本机运行就可以使用了。
    希望这篇博文对你有帮助!

    展开全文
  • 接口文档示例

    万次阅读 2019-06-17 16:54:55
    markdown 接口文档模板
  • 什么是接口文档?接口文档书写规范?

    千次阅读 2018-12-14 14:37:34
    在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。  接口文档分为四部分:请求方法type、请求...
  • 正确规范写接口文档

    万次阅读 多人点赞 2018-05-17 14:14:27
    前言 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。下面我总结下自己看到的优秀接口文档。银联接口文档案例:5.2.2 统一收单线下交易查询...
  • 完整接口文档见http://download.csdn.net/download/qq_36467463/10214090
  • 自动生成接口文档之JApiDocs教程

    万次阅读 2020-12-09 16:06:20
    写完接口文档,一旦代码返回结果,参数等出现变动,接口文档还得随之改动,十分麻烦,违背了我们简单,快速,低bug的开发初衷。 所以,自动生成接口文档的工具就出现了。大家最熟悉的应该就是swagger了,我并没有...
  • 接口文档定义

    千次阅读 2019-03-18 21:23:36
    一、什么是接口文档? 在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。 二、为什么要写接口...
  • CRMEB接口文档

    千次阅读 2019-09-29 09:01:11
    CRMEBv3.0采用TP6框架,前后端完全分离...一下是部分接口文档,全部接口文档还得联系官方 地址:http://github.crmeb.net/u/lingting crmeb crmeb api 公共信息 CRMEB API接口说明 公共接口 活动状态 基本信息...
  • api接口文档模板

    千次下载 热门讨论 2014-03-06 16:00:51
    api接口文档模板
  • 接口文档规范

    2018-09-19 15:45:17
    接口文档规范 前言:为了规范化项目管理,方便团队扩充后的新同事对项目的熟悉及自主入手开发,现决定将项目文档逐步规范化。 所有新增接口,按照规范格式撰写接口文档; 所有修改的接口,如果之前有对应的接口文档...
  • 接口文档相关问题

    千次阅读 2019-11-01 16:45:28
    接口文档相关内容
  • 软件开发 接口文档

    2019-07-19 09:11:47
    接口文档没有固定的样式,只要把相关的信息显示出来就可以 例如: 接口名称 接口说明 接口地址 请求参数 返回参数 错误码(一般大批量的接口都使用统一的错误码来返回) 下面是本人使用过的接口文档样式 ...
  • 后台接口文档示例

    千次阅读 2019-09-28 05:08:39
    什么是接口文档? 在项目期间,前后端是分离开发的,为了前后有连贯性,就必须由前后开发工程师共同定义接口、写接口文档再根据接口文档去开发,一直到项目结束。 接口文档规范 方法  也就是我们常写的...
  • 我刚接触这行,人给了我一份接口文档,叫我写接口,存进数据库之后之后用定时任务每分钟取一次.......这里说的接口到底是些个什么,是写service还是dao,希望指导一下谢谢
  • Android 接口文档

    千次阅读 2016-12-28 14:42:15
    前言每个项目进行研发之前,都会有很多的相对应的文档,当然比较重要的一个就是接口文档,当然接口文档版本也有很多,这边只是把自己写文档的一部分内容写个示例记录一下,方便以后自己查看。当然大家有很好的建议和...
  • 项目开发接口文档

    千次阅读 2019-03-11 10:44:13
    项目开发接口文档
  • 没有 Web 接口文档如何进行接口测试

    千次阅读 2019-03-09 23:30:37
    在进行接口测试之前,一般开发会提供接口文档,给出一些接口参数和必要熟悉,便于我们编写接口脚本。但如果没有提供接口开发文档的请求下,我们该如何编写接口测试脚本呢?在编写测试脚本前要做哪些必要的准备呢? ...
  • 接口文档格式

    千次阅读 2018-10-23 19:49:04
    接口文档格式 一 接口地址: http://v.juhe.cn/exp/index 二 返回格式: json 三 请求方式 http post/get 四 请求示例 http://xxx/index?key=key&amp;com=sf&amp;no=123 五 请求参数 名称 必填 ...
  • swagger导出接口文档

    千次阅读 2020-04-20 18:54:06
    最近工作上需要用Swagger导出接口文档 经过查找资料总结了一下: Swagger简介 1、是一款让你更好的书写API文档的规范且完整框架。 2、提供描述、生产、消费和可视化RESTful Web Service。 3、是由庞大工具集合支撑的...
  • java 后台接口文档

    万次阅读 2019-02-25 16:31:33
    规范的手写Java 后台接口文档:https://www.showdoc.cc/demo?page_id=10

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 64,821
精华内容 25,928
关键字:

接口文档