精华内容
下载资源
问答
  • 例1 update更新接口:参数有两个 ...前端调用updateUser请求后端接口的方法: 更新功能的提交按钮: 请求后端接口: 例2:getList请求接口 前端调用getList请求后端接口的方法: 请求后端接口

    例1 update更新接口:参数有两个
    在这里插入图片描述
    前端调用updateUser请求后端接口的方法:
    在这里插入图片描述
    更新功能的提交按钮:

    在这里插入图片描述
    请求后端接口:
    在这里插入图片描述
    例2:getList请求接口
    在这里插入图片描述
    前端调用getList请求后端接口的方法:
    在这里插入图片描述
    请求后端接口:
    在这里插入图片描述

    展开全文
  • 后端接口文档的编写

    千次阅读 2020-04-30 00:26:15
    后端接口文档的编写: 1. 为什么我们前端也要了解后端接口文档的一个编写过程? 作为一名前端FE[front end],前后端交互测试你必须懂。 是为了更好的前后端交互,工作流程的书写! 2. 接口文档编写方式很多 [常用]...

    后端接口文档的编写:

    1. 为什么我们前端也要了解后端接口文档的一个编写过程?

    作为一名前端FE[front end],前后端交互测试你必须懂。

    是为了更好的前后端交互,工作流程的书写!

    2. 接口文档编写方式很多 [常用]

    • ShowDoc 【第三方平台】 https://www.showdoc.cc;公司的接口放在第三方平台,存放安全隐患

    • 自行编写 => apidoc https://apidocjs.com/

      使用流程:

      1. 安装: npm install apidoc -g

      2. 使用:apidoc -i myapp/ -o apidoc/ -t mytemplate/

        -i  表示输入的目录
        -o  表示输出的目录
        -t  表示模板
        
        切记,名字根据自己项目的命名来书写。
        myapp        表示:输入/源目录名。项目文件的位置               apidoc -i myapp/
        apidoc       表示:输出目录名。放置生成的文档的位置		     apidoc -o apidoc/
        mytemplate   表示:使用模板输出文件。您可以创建和使用自己的模板。 apidoc -t mytemplate/
        
    展开全文
  • CRMEB源码后端接口文档,文档标记清晰,md格式,可自由存储,CRMEB系统是一个采用前后端分离开发的新零售商城系统,非常容易二次开发!
  • 现在项目开发都是前后端分离,该代码主要是教初学者使用springboot开发接口,其中包括数据返回的包装类,自定义异常,返回码的枚举等,并进行简单的测试,达到抛砖引玉的作用,初学者能更容易地接受,共同进步.
  • php后端接口文档的编写

    千次阅读 2020-04-21 09:58:11
    php的增删改查接口文档,下面的所有域名我都用xxx.xxx.xxx代替 一、添加 1、接口地址:xxx.xxx.xxx/index/register/insert 2、支持格式:JSON 3、请求方式:post 4、请求参数: 名称 说明 是否必须 sn 点位...

    php的增删改查接口文档示例,下面的所有域名我都用xxx.xxx.xxx代替
    一、添加
    1、接口地址:xxx.xxx.xxx/index/register/insert
    2、支持格式:JSON
    3、请求方式:post
    4、请求参数:

    名称说明是否必须
    sn点位sn码

    5、请求成功示例:

    {
    	"code": 200,    
        "msg": "添加成功!",   
        "id": "7229"
    }
    

    6、请求失败示例:

    {
    	"code": 1000,    
        "msg": "请求方式错误!"
    }
    

    7、返回状态码说明:

    状态码code说明msg
    200添加成功!
    1000请求方式错误!
    1001请求参数缺失!
    1002该sn码数据已存在!
    1003该sn码长度不符!
    1005添加失败!

    二、删除
    1、接口地址:xxx.xxx.xxx/index/register/delete
    2、支持格式:JSON
    3、请求方式:get
    4、请求参数:

    名称说明是否必须
    id点位id

    5、请求成功示例:

    {
    	"code": 200,    
        "msg": "删除成功!"
    }
    

    6、请求失败示例:

    {
    	"code": 1005,    
        "msg": "删除失败!"
    }
    

    7、返回状态码说明:

    状态码code说明msg
    200删除成功!
    1000请求方式错误!
    1001请求参数缺失!
    1005删除失败!

    三、修改
    1、接口地址:xxx.xxx.xxx/index/register/update
    2、支持格式:JSON
    3、请求方式:post
    4、请求参数:

    名称说明是否必须
    id点位id
    sn点位sn码

    5、请求成功示例:

    {
    	"code": 200,    
        "msg": "修改成功!",   
        "id": "7229"
    }
    

    6、请求失败示例:

    {
    	"code": 1000,    
        "msg": "请求方式错误!"
    }
    

    7、返回状态码说明:

    状态码code说明msg
    200修改成功!
    1000请求方式错误!
    1001请求参数缺失!
    1002该sn码数据已存在!
    1003该sn码长度不符!
    1005修改失败!

    四、查询
    1、接口地址:xxx.xxx.xxx/index/register/select
    2、支持格式:JSON
    3、请求方式:get
    4、请求参数:

    名称说明是否必须
    id点位id

    5、请求成功示例:

    {
    	"code":200,
    	"msg":"请求成功!",
    	"data":
    	{ 
    	    "id": 7222,
    	    "sn": '123456789',
    	    "name": "楠楠",
    	}
    }
    

    6、请求失败示例:

    {
    	"code": 1001,    
        "msg": "请求参数缺失!"
    }
    

    7、返回状态码说明:

    状态码code说明msg
    200请求成功!
    1000请求方式错误!
    1001请求参数缺失!
    1005请求失败!
    展开全文
  • 后端纯api的接口规范。以及一些代码习惯,包括@valid校验、后端接口异常处理、pagehelper整合、mybatis整合。
  • 后端接口需求.docx

    2020-10-09 17:42:37
    1. 文件查询:此接口用的地方很多,很重要,参数有:文件ID列表、上传时间区间、文件分类ID列表、资产编码列表、名称列表、关键字列表、文件状态列表、文件流程状态列表、上传者列表,所有参数中,至少有一个参数不...
  • restful前后端分离api接口文档模板,javaweb开发接口文档
  • 接口文档模板.docx

    2020-10-25 22:49:25
    基本接口文档说明,用于java开发中多系统对接时,本系统记录并提供给对端系统的一份简要接口说明,便于调用方开发。
  • 后端API接口文档工具

    千次阅读 2019-03-31 16:00:12
    接口文档生成工具 APIdoc 和 swagger
    展开全文
  • 后端开发之如何写接口设计文档

    千次阅读 2021-04-15 15:07:55
    当我们说到接口时,首先要分前端和后端,前端有Android、IOS、Js,后端定义返回值、参数、请求方式、协议等。系统A调用系统B,系统B调用系统C,像是把多个系统连接起来的一座桥梁,各自遵守相同的约定,但他本身是一...
  • vue写后端接口

    2021-04-26 20:03:12
    1.分别执行以下代码 npm init -y npm i express npm i nodemon 在pageage.json中吧scripts中的 text改成 “dev”: “nodemon index.js” 这样就可以热启动了 2. //引入 express const express = require("express");...
  • Node后端目录结构 sql/index.js // 封装好的数据库的基本操作 增 删 改 查 const sql = { // 插入操纵 insert (ColName, insertData) {//所需参数为:ColName:数据库中所需添加的集合名称以及规则,insertData:添加...
  • 后端 API 接口文档 Swagger 使用指南

    千次阅读 2019-12-27 13:49:00
    点击上方Java后端,选择设为星标优质文章,及时送达作者 |Yrion链接 |cnblogs.com/wyq178/p/10291447.html前言:作为一个以前后端分离为模式...
  • 今天小编就为大家分享一篇Django 自动生成api接口文档教程,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
  • 项目名称:ftest测试公开版(博客) 开发日期:2020-11-15 开发者:fnee 环境:工具/IDEAIU | jdk/1.8 | maven/4.0.0 | SpringBoot/2.3.5.RELEASE 系统:Windows/开发 文章目录一、项目基础搭建1....
  • 如何设计和编写标准的后端接口

    千次阅读 2020-10-11 13:18:59
    如何设计和编写标准的后端接口
  • "title": "接口文档", "url": "http://localhost:256" } 项目根目录下创建apidoc.json, 内容为 { "name": "接口文档", "version": "1.0.0", "description": "腾讯云服务器接口文档", "title":
  • 后端完成一个 API 接口时,通常需要 与前端人员沟通接口的细节,这时候,一个文档就能节省很多效率,大大减少沟通成本,如何撰写一份规范文档呢? 功能描述 用最简洁清晰的语言,让不懂后端的前端一看就懂。 ...
  • springboot/web项目优秀的后端接口体系,看一篇就够了 项目构建-统一参数校验,统一结果响应,统一异常处理,统一错误处理,统一日志记录,统一生成api文档 1. 前言 一个后端接口大致分为四个部分组成:接口地址(url...
  • 接口文档示例.docx

    2019-08-13 16:34:08
    开发文档模版,便于后台技术开发人员与前端开发人员的交流
  • 软件工程的两种方法下,由后端决定接口都是不对的。 第一种软件工程的方法:瀑布模型,自顶而下,逐步细化。 接口会变,但是接口要提前设计。接口不是后端开发完成之后才“自然”产生的,那不是自然,而是无序。 ...
  • 接口文档 -.docx

    2019-05-28 00:59:24
    小公司接口文档: 简单 方便 实用. 首选Swagger-ui, 其次选择阿里开源的rap2.
  • SpringBoot写后端接口,看这一篇就够了!

    万次阅读 多人点赞 2020-09-15 14:22:52
    摘要:本文演示如何构建起一个优秀的后端接口体系,体系构建好了自然就有了规范,同时再构建新的后端接口也会十分轻松。 一个后端接口大致分为四个部分组成:接口地址(url)、接口请求方式(get、post等)、请求...
  • 点击上方[全栈开发者社区]→右上角[...]→[设为星标⭐]前言一个后端接口大致分为四个部分组成:接口地址(url)、接口请求方式(get、post等)、请求数据(request)、响应...
  • java开发中定义接口文档,可以作为定义接口规范的一个参考。具有一定的参考价值。方便前后端分离的项目中的交流
  • 前后端开发接口文档

    2019-03-15 16:08:19
    课程提供了前后端开发接口文档(采用 Swagger 语言进行编写),并与 Nginx 进行了整 合。双击 Nginx 执行文件启动后,在地址栏输入 http://localhost:801 即可访问 API 文档
  • Java后端开发工作 - 写接口

    千次阅读 多人点赞 2020-04-15 16:52:22
    我在公司的工作内容是,对于一个BS应用,负责服务器端开发工作,Java语言。与前端开发人员合作,最终提供给前端RESTFUL接口,保证页面正常响应。 经验之谈 一个接口可以理解为一个业务逻辑,一个业务...后端提供给...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 92,645
精华内容 37,058
关键字:

后端接口文档怎么写