背景 在团队两年多陆续负责了几个项目的开发上线已经代码的review,特别是对老项目的重构过程中,发现之前的API设计是没有任何规范和约定的,不同的开发同学有不同的习惯,因此需要一套规范去约定,现在分享一下我们目前试运行的一套规范,一起交流完善下。 WebAPI开发流程
WebAPI(Application Programming Interface)是一种用于开发Web应用程序的软件接口,用于实现不同应用之间的数据交互和通信。目前,很多互联网公司都在开发并使用自己的WebAPI,例如阿里巴巴的OpenAPI、百度的APIStore等等。 本文将围绕WebAPI的开发和接口管理技术展开,探讨如何开发高质量的WebAPI并管理好API接口。 一、WebAPI的...
import net.http.ServerBuilder main () {//1. 构建 Server 实例let server =ServerBuilder() .addr("127.0.0.1") .port(8080) .build()//2. 注册 HttpRequestHandlerserver.distributor.register("/index", {httpContext =>httpContext.responseBuilder.body("Hello 仓颉!") })//3. 启动服务server.serve()...
1. 部署Self-Hosting自承载WebApi服务 将CSFramework.WebAPI.Demo.SelfHosting项目设为启动项目,直接运行即可。 CSFramework.WebAPI.Demo.SelfHosting项目是个可以直接运行的控制台应用程序,运行成功后,Console输出启动WebApi服务器成功。 2. 部署IIS承载的WebApi服务 在CSFramework.WebAPI.Demo.IISHosting项目点右键【发布】...
WebAPI口可以有效的提高系统的可用性和可维护性,是将单体应用架构慢慢演变为微服务架构的重要组成部分,因此开发WebAPI口也变得日益重要。 一、WebAPI口定义 WebAPI口是一种为客户端和服务端之间提供交互通信的接口,客户端和服务端之间通过该接口实现数据交互,服务端提供数据服务,而客户端通过调用接口消费服务。WebAPI口...
生成中接口的请求必须加token进行权限校验,比如校验是否登录获取的token,校验该用户是否具体该接口访问权限等等。 这里以判断用户是否登录做例子进行讲解。 配置SpringContextUtil 项目中如果静态类根据beanId来获取对象,需要提前注入SpringContextUtil。 @SpringBootApplicationpublicclassWebApiStartApplication{publicstaticvoidmain...
这里面主要设计以下接口: 用户登录获取accessToken news的增删改查接口 为了保存accessToken,需要引入redis,为了定义返回的json,需要定义公共的JsonResult,下面依次说明 pom.xml添加依赖 <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId></dependency> ...
无论是前端开发者还是后端开发者,都需要对接口进行频繁的调试以确保数据的正确传输和处理。本文将分享一些WebAPI接口调试的技巧,帮助开发者提高调试效率。 一、选择合适的调试工具 Postman:Postman是一款功能强大的API开发和调试工具,支持多种HTTP请求方法,如GET、POST、PUT、DELETE等。它允许用户构建请求、发送请求并查看...
1、WebApiTestClient组件作用主要有以下几个: (1)、将WebApi的接口放到了浏览器里面,以可视化的方式展现出来,比如我们通过http://localhost:8080/Help这个地址就能在浏览器里面看到这个服务里面所有的API接口以及接口的详细说明,省去了我们手写接口文档的麻烦。
新建一个FileController空API控制器: [Route("api/[controller]/[action]")] [ApiController] [EnableCors("CorsPolicy")]//配置Cors,允许跨域 public class FileController : ControllerBase { …