手机用户57280362794
因为我是做Java开发的，所以就按照Java的开发流程说一下；首先一个好的API接口，设计是要下功夫的，细节就不在这里说了，这里还是主要说实现；如果开发环境具备，前后大概也就不到十分钟，就可以完成一个简单的API接口的开发（只是个demo）。
0、开发前准备：电脑上需要安装JDK、Maven和IDE。
1、新建一个基于Spring Boot的项目，为了快速完成，我选择登录到【
start.spring.io
】网站上，生成一个项目。通过【Search dependencies to add】可以选择需要引入的包，我这里只引入了Web，也就是Spring MVC；假如你需要通过Mybatis访问数据库，也可以在这里选择；然后点击生成项目。
2、将下载好的项目，解压后引入到你的IDE中，新建一个类：
com.wukong.apidemo.controller
.ApiController3、在这个类中增加一个方法，并主要使用@RestController、@RequestMapping、@ResponseBody两个标签，整个类大概是这个样子：
4、这时候最简单的一个API接口就完成了，我们可以启动项目后，访问对应的接口地址，得到接口的返回信息：
5、我们再对这个接口稍微加工一些，让swagger帮助我们生成一个接口文档：
5.1、在
pom.xml
中进入swagger需要的包：
5.2、对ApiController增加：@Api、@ApiOperation、@ApiImplicitParams等标签：
5.3、这时候启动项目后，访问：
http://10.141.48.41:8080/swagger-ui.html
5.4、这里留了一个小问题，swagger的配置少了一步，按照上面的做饭，访问swagger的页面是会报404的，大家可以尝试解决。
我将持续分享Java开发、架构设计、程序员职业发展等方面的见解，希望能得到你的关注。
会点代码的大叔
作为BAT的Java开发工程师，来分享下我在公司里写的项目（脱敏）中的封装api接口部分。
我们使用的是SSM框架，但是这里其实不论是SSM还是SSH，抑或是SPRING BOOT，接下来的介绍都是通用的，因为主要是通过介绍注解（annotation），而不是xml文件。
Controller.Class
首先，API接口需要出现在controller层，因此，在类名上方，需要至少两个注解，@controller，用于在项目启动的时候告诉spring，这个类是controller层的，需要加载好；@requestMapping，这个注解相当于指明了api的url中的一部分。
如果一个服务绑定的域名是
http://xx.yy.com
，然后requestMapping中的内容意味着，url为http://xx.yy.com/dispatch
/.... 格式的请求，会被转发到当前这个类中。
Controller.function
看完接下来我们看函数部分，这里首先也要加一个responseBody注解，这个注解的含义是将controller层中，函数的返回对象通过转换器，转换为指定的格式，写入到http response返回对象的body中去，也就是说下面这个函数返回的String，直接作为response的body内容返回给了用户。
接下来，依旧是requestMapping注解，相信大家也能了解了，复用上面的例子，当url为
http://xx.yy.zz/dispatch/validate
的时候，相当于调用了这个validateParams函数，并且这个请求request的body就会作为body参数，一并传入这个函数。
这里大家可以能注意到了，上面的函数的参数名中用的是requestBody，而下面用的是formParam，虽然二者都是post请求，但是参数接收方式却不一样。这就意味着，代码里指定了不同的接收方式，request的body里也必须用对应的方式才能将数据传递给函数。上图中body用raw形势的就可以，而下图则要求用application/x-www-form-urlencoded格式的body。
最后，上面介绍的都是post请求的api，下图介绍了GET请求的api如何写。可以看出，注解方面，requestMapping里指定requestMethod为GET即可。在函数的参数方面，需要用requestParma注解来接收，如下图。当你发送
http://xx.yy.com
/dispatch/getMyContract?username=xiaomin&password=123 这个请求的时候，就相当于调用了下面的getMyContract函数，并且传入的username参数为xiaomin，password参数为123.
我是苏苏思量，来自BAT的Java开发工程师，每日分享科技类见闻，欢迎关注我，与我共同进步。
苏苏思量
API（Application Programming Interface,应用程序编程接口），目的是提供应用程序与开发人员基于某软件或硬件访问获取数据。
PHP简单示例：
假设接口访问地址 http://127.0.0.1/api.php，api.php文件内容是
访问接口 http://127.0.0.1/api.php
特别说明
上术示例只是最最基本的实现方式上的一个小示例！市面上再复杂规范的API，无非就是一个根据客户端的请求参数对数据的筛选。所以这里也给出一个比较规范的API设计思路使用标准的HTTP方法，规范路由请求。
无状态性，每个请求都是一个新的请求来对待。
支持多种资源表示方式 (xml, json等)。
数据格式规范化，做好数据的安全性。
平常心学院
作为一名开发者，在此发表我的一些观点，一个好的Api一定是一个可读性比较高的Api项目。可以从以下几点入手
1、不论Api用何种语言编写，多少人编写，都需要达到每个接口的输出规则都是一致的。确定好开发前的开发规范，包括入参使用何种驼峰命名，返回的json数据又是以何种规则对外输出这些都需要在编码前考虑好。
2、Api需要对入参做必要验证。
3、需要提供统一的验证机制，在一定程度上防止遭遇恶意请求。
4、增加必要的日志记录，为以后的排查提供数据依据。
5、考虑Api的响应速度可以适当的引用缓存技术，比如Redis。
6、做好项目的文档记录。
以上就是我的一些建议，我是一名开发人员，喜欢我的欢迎关注🍀🍀🍀🍀🍀🍀🍀
陆垚玛丽
API接口设计个人觉得需考虑其扩展性能特别是对外公共接口，否则多个业务需求类似会存在两套API的情况，比较浪费资源。其次api名称，请求参数，返回结果必须有确定含义，容易上手，返回结果一般我设计时分为2部分，系统层面信息，业务层面信息，系统层面例如api调用异常，一般用约定好的错误码标识，业务层面就很宽泛，例如银行业务联网核查，查不到用户信息，从系统层面这是OK的，业务层面肯定是不行的，不可能用户在银行有账户却没有用户信息，当然可能数据库在做迁移导致暂时访问为空，这种业务错误也可以通过状态码或者状态标识boolean值+错误信息返回给客户端，这样api出问题可以快速定位是系统问题还是业务问题
定格往忆
可以试试showdoc,很方便编辑查看，安装很方便。
小崔技术之路
如果只是一个简单API实例的话，不涉及数据库等，可以实现的语言可以说非常的多，但是我觉得比较简单的是nodejs和go 因为他们有自己的原生服务模块，nodejs有http模块，go有net模块，都直接可以起一个web服务，无需Apache，Tomcat等web服务器
柏舟63677578
swagger 接口自动生成，按文档说明的格式注释，可以一目了然各参考说明
