api接口开发（api接口开发规范）

本篇文章给大家谈谈api接口开发，以及api接口开发规范对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。 今天给各位分享api接口开发的知识，其中也会对api接口开发规范进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、如何开发自己的API接口？
• 2、api接口是什么意思？
• 3、magic-api 快速接口开发
• 4、API接口是什么？
• 5、什么是API接口？主要作用是什么？

如何开发自己的API接口？

开发自己的api需要准备几个工作：

第一：提高你的API的功能

第二：设置你的API访问协议，如：socket,http

第三：升级你的API的认证方式,如：curl,oauth

第四：找到属于你的API开发语言

api接口是什么意思？

是指同一计算机不同功能层之间的通信规则称为接口。
java接口作用：
1、利于代码的规范。这样做的目的一方面是为了给开发人员一个清晰的指示，告诉他们哪些业务需要实现；同时也能防止由于开发人员随意命名而导致的命名不清晰和代码混乱，影响开发效率。
2、有利于对代码进行维护。可以一开始定义一个接口，把功能菜单放在接口里，然后定义类时实现这个接口，以后要换的话只不过是引用另一个类而已，这样就达到维护、拓展的方便性。
3、保证代码的安全和严密。一个好的程序一定符合高内聚低耦合的特征，能够让系统的功能较好地实现，而不涉及任何具体的实现细节。这样就比较安全、严密一些，这一思想一般在软件开发中较为常见。

magic-api 快速接口开发

magic-api 是一个基于Java的接口快速开发框架api接口开发，编写接口将通过magic-api提供的UI界面完成，自动映射为HTTP接口。

1，引入magic-api-spring-boot-starter依赖
org.ssssssss

magic-api-spring-boot-starter

1.7.1
2，application.yml 中配置

magic-api:

#配置web页面入口

web: /magic/web

resource:

# location: /data/magic-api

type: database # 配置接口存储方式，这里选择存在数据库中

table-name: magic_api_file # 数据库中的表名

3，启动服务，访问magic-api web页面

magic-test/magic/web

1，RequestParam

GET http://localhost:9999/xxx/xxx?name=abcage=49

这样的URL参数magic-api 会自动将name和age映射为同名变量

2，表单参数

POST http://localhost:9999/xxx/xxx

name=abcage=49

这样的表单参数magic-api 也会自动将name和age映射为同名变量。

3，Request Header参数获取

magic-api 会对所有RequestHeader统一封装为一个名为header的变量 如要获取 token 可以通过header.token 来获取。

4，POST请求的Request Body参数获取

{

"name": "magic-api"

}

如要获取name属性 则可通过 body.name 来获取

5，Path参数获取

主要是针对URL定义为http://localhost:9999/user/{id} 的类似接口

如要获取path路径上的id可通过path.id 或 id来获取

6，Cookie，Session参数获取

可以通过cookie.xxx，session.xxx来获取

1，#{} 注入参数，${} 拼接参数

作用和mybatis用法一致

id = #{id};

id=${id};

2，动态SQL参数

通过?{condition,expression}来实现动态拼接SQL，如果条件成立则拼接后部分内容SQL中，与mybatis中的if标签基本一致

return db.select("select * from sys_user ?{id,where id = #{id}}");

相当于mybatis中的

3，Mybatis 语法支持

1.6.0以后的版本支持Mybatis语法

操作入口 db.table('table_name')

1，insert

return db.table('sys_user').insert({ user_name : '李富贵', role : 'admin'})

// insert into sys_user(user_name,role) values('李富贵','admin')

2，update

return db.table('base_dict').primary('code').update({ code: 'insertTerst', name : '测试insert'})

//update base_dict set name = ? where code = ?

3，save

用法和insert相似

return db.table('sys_user').primary('id', uuid()).save({user_name: '李富贵'});

// insert into sys_user(id,user_name) values('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx','李富贵');

4，select，page，where

return db.table('sys_user').select()

return db.table('sys_user').page()

return db.table('sys_user')

.where()

.like('user_name','%李富贵%')

.eq('role','admin')

.select()

yml中配置分页参数

magic-api:

page-config:

size: size # 页大小的请求参数名称

page: page # 页码的请求参数名称

default-page: 1 # 未传页码时的默认首页

default-size: 10 # 未传页大小时的默认页大小

自动分页

使用yml中配置的分页参数

return db.page("""select * from base_dict_detail""")

手动分页

跳过前3条记录，然后取5条

return db.page("""select * from base_dict_detail""",5,3)

自定义分页参数获取

实现 PageProvider接口，复写getPage方法 {

public Page getPage(RuntimeContext runtimeContext) {

long page = 2;

long pageSize = 3;

return new Page(pageSize, (page - 1) * pageSize);

}

此模式会覆盖yml的配置内容

目前内置api接口开发了三种状态码，分别为 执行成功(1)，参数验证失败(0)，以及系统异常(-1)

自定义状态码

magic-api:

response-code-config:

success: 200 #执行成功的code值

invalid: 400 #参数验证未通过的code值

exception: 500 #执行出现异常的code值

默认返回格式

{

"code": 1, // 状态码

"message": "success", // 状态说明

"data": ..., // 返回的数据内容

"timestamp": 1629610503506, // 服务器时间

"executeTime": 1 // 执行时间

}

自定义返回格式

magic-api:

response: |- #配置JSON格式，格式为magic-script中的表达式

{

code: code,

message: message,

data,

timestamp,

requestTime,

executeTime,

}

自定义结构配置

实现ResultProvider接口，重写buildResult方法

引入swagger依赖

在yml文件中配置

magic-api:

swagger-config:

version: 1.0.0

description: magic测试文档

title: magic测试

name: 配置化实现

location: /v2/api-docs/magic-api/swagger2.json

Magic-api通过springboot自动配置的方式配置了resource,dataSource,interceptor等内容。

在服务启动时，生成MagicConfiguration注入容器时，通过mappingHandlerMapping.registerAllMapping();来注册所有映射(即在界面上配置的接口请求地址和接口的实际处理类、方法的映射)。映射关系注册到handleMapping中，并在内存中通过ConcurrentHashMap来缓存映射关系

接口调用时，在DispatcherServlet中通过url去寻找handler,找到magic-api的统一处理RequestHandler以及处理方法invoke。

在invoke中根据请求方法和路径获取接口信息封装在ApiInfo中，然后进行参数的验证封装。实际脚本的执行，以及对返回结果的包装

API接口是什么？

是指同一计算机不同功能层之间的通信规则称为接口。
java接口作用：
1、利于代码的规范。这样做的目的一方面是为了给开发人员一个清晰的指示，告诉他们哪些业务需要实现；同时也能防止由于开发人员随意命名而导致的命名不清晰和代码混乱，影响开发效率。
2、有利于对代码进行维护。可以一开始定义一个接口，把功能菜单放在接口里，然后定义类时实现这个接口，以后要换的话只不过是引用另一个类而已，这样就达到维护、拓展的方便性。
3、保证代码的安全和严密。一个好的程序一定符合高内聚低耦合的特征，能够让系统的功能较好地实现，而不涉及任何具体的实现细节。这样就比较安全、严密一些，这一思想一般在软件开发中较为常见。

什么是API接口？主要作用是什么？

API英文全称为：Application Programming Interface，中文意思是应用程序编程接口，它是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力。

主要作用：

API之主要目的是提供应用程序与开发人员以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。提供API所定义的功能的软件称作此API的实现。API是一种接口，故而是一种抽象。

扩展资料：

API数据接口的好处：

1、良好的接口设计可以降低系统各部分的相互依赖，提高组成单元的内聚性，降低组成单元间的耦合程度，从而提高系统的维护性和扩展性。应用程序接口是一组数量上千、极其复杂的函数和副程序，可让程序员做很多任务。

2、98数据致力于打造高质量API，除了自身的数据外，来自合作伙伴的各类API数据也是经过慎重的筛选，接口的质量和稳定性比较好，适合对接口质量和稳定性有较高要求的开发者。API数据接口作为众多开发人员进行开发工作最有效的助手，以后也会发挥着更大的作用，所以找到合适的接口才是最为重要的。

参考资料来源：百度百科-api

关于api接口开发和api接口开发规范的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 api接口开发的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于api接口开发规范、api接口开发的信息别忘了在本站进行查找喔。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。