【Express】应用案例（一） - RESTful接口设计规范

最新推荐文章于 2022-11-28 13:24:05 发布
最新推荐文章于 2022-11-28 13:24:05 发布
阅读量434 收藏
点赞数
分类专栏： Node.js
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_44972008/article/details/118279870
版权
本文详细介绍了如何使用Express实现RESTful接口设计，遵循RESTful接口规范，包括协议、域名、版本、路径、HTTP动词、过滤信息、状态码、返回结果、错误处理、身份认证和跨域处理等关键要点。
摘要由CSDN通过智能技术生成

文章目录

开源项目的地址
https://github.com/gothinkster/realworld
在这里插入图片描述

1. RESTful接口设计规范

1.1 协议

API与用户的通信协议，尽量使用HTTPs协议

1.2 域名

应该尽量将APP部署在专用域名之下

https://api.example.com

如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。

https://example.org/api/

1.3 版本

应该将API的版本号放入URL

https://api.example.com/v1/

另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github 采用这种做法。

1.4 路径

路径又称"终点"(endpoint) ，表示API的具体网址。

在RESTful架构中，每个网址代表一种资源（ resource)，所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合” (collection)，所以API中的名词也应该使用复数。

举例来说，有一个API提供动物园(zoo)的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。


                

                
                
        

        

    




        

            

                    
                      最低0.47元/天 解锁文章
                        
                    
            

        

    

      

        

            

              
                
                  YK菌
                
              
            

            

                关注
              
            

        

        

          
    
            
  • 
              
                
                
                
                
                      0
                
              
              
    点赞
    
            
    • 
            
  • 
              
                
                
                
              
              
    踩
    
            
    • 
            
  • 
              
                
                
                
                
                    0
                
              
              
    
                
    
                  
                    收藏
                  
                
    
              
    
              
    
                
    
                  觉得还不错?
                  
                    一键收藏
                  
                 
                
    
              
    
            
    • 
          
  • 
            
    
              
              
            
    
              
              
              
                  1
              
            
            
    评论
    
          
    • 
          
  • 
          
    • 
          
  • 
            
              
            
              
    
            
              
                
            
    
          
    • 
        

      

      

            

                专栏目录
          










                



	

		

			

				
					
大前端 - nodejs - express - 使用express开发接口服务案例（realword）

				
			

			

				

					weixin_38245947的博客
				

				

					04-01
					
					1551
					
				

			

		

		

			
				
接口案例-RESTful接口规范介绍
接口域名：https: //example.org/v1/api
v1:版本号




状态码规范：


创建项目
mkdir realworld-api-express
cd realworld-api-express
npm init -y
npm i express

app.js
const express = require('express')
const app = express()

const PORT = process.ENV.PORT || 3

			
		

	



                

              
                



	

		

			

				
					
restful 接口开发规范（RESTfulAPIdesignguide）

				
			

			

				

					02-01
				

			

		

		

			
				
开发restful接口应该遵循统一的规范，保持规范的统一才能方便维护和应用

			
		

	



                


  
              

                


	

		

			

				
					
使用express 写接口

				
			

			

				

					qq_42714690的博客
				

				

					03-05
					
					841
					
				

			

		

		

			
				
一、接口开发规范（Restful API）
1、明确需求
作用： 保证大家的编写规范一样
举例：

后端将资源发布到URL上->前端通过URL访问资源->并通过HTTP动词表示要对资源进行的操作
后端定义接口->前端请求接口->HTTP动词表名操作目的（get获取post新建put更新等）


举栗
列表页：访问 - /模块名	          （get）
详情页：访问 ...

			
		

	





	

		

			

				
					
express + restful

				
			

			

				

					weixin_33937913的博客
				

				

					08-30
					
					308
					
				

			

		

		

			
				
express
http://www.expressjs.com.cn/

Express 是一个基于 Node.js 平台的极简、灵活的 web 应用开发框架，它提供一系列强大的特性，帮助你创建各种 Web 和移动设备应用。

http://www.expressjs.com.cn/starter/hello-world.html


var express = require(...

			
		

	



		

			
		



	

		

			

				
					
RESTful（Express）

				
			

			

				

					m0_61388464的博客
				

				

					08-30
					
					359
					
				

			

		

		

			
				
使用Express搭建简单的RESTful服务

			
		

	





	

		

			

				
					
node用express写后端restful接口实战一：npm生成express项目、express-generator生成express项目、用nodemon实时监听代码变化

				
			

			

				

					*
				

				

					10-18
					
					575
					
				

			

		

		

			
				
node后端，常用express 和 koa用来开发
一、用npm生成express项目
1.新建 Express 项目
这一集，咱们来正式跑一个Express项目
$ mkdir myapp
$ cd myapp
$ npm init

同样的新建项目文件夹后，使用 npm init，创建 package.json。这次没有使用 -y 参数，所以命令过程中会问我们几个问题，大多数问题都是直接按回车就可以了。
但有一个地方要注意，项目的入口文件咱们填写 app.js：
entry point: (index

			
		

	





	

		

			

				
					
基于Vue+Nodejs+Express在线购物商城设计源码案例设计.zip

					
最新发布

				
			

			

				

					04-19
				

			

		

		

			
				
3. **Express.js**：Express是Node.js的一个Web应用框架，它简化了构建RESTful API的过程。在本项目中，Express被用来处理HTTP请求，提供路由管理，以及与数据库的交互，如用户认证、商品管理和订单处理等。  4. **...

			
		

	





	

		

			

				
					
基于Vue+Express+MongoDB医院预约挂号系统APP设计源码案例设计.zip

				
			

			

				

					04-19
				

			

		

		

			
				
接下来，Express.js是Node.js上的一个快速、开放、极简的web开发框架，它简化了服务器端的API接口设计和路由管理。在本案例中，Express被用来搭建后端服务器，处理HTTP请求，与MongoDB数据库进行数据交互。开发者...

			
		

	





	

		

			

				
					
基于Vue+express+mongoDB在线点餐系统设计源码案例设计.zip

				
			

			

				

					04-19
				

			

		

		

			
				
该在线点餐系统是基于Vue.js、Express....这个源码案例设计可以作为学习者了解Web全栈开发流程的一个实践项目，涵盖了前端UI设计、前后端数据交互、数据库操作以及服务器部署等多个方面，对提升开发者技能有很大帮助。

			
		

	





	

		

			

				
					
RESTful_API:基于前后端分离使用框架 express 4.X 、数据库 Mysql 、 MVC模式 、 Swagger 、 RESTful规范、Webpack实现API接口的Node服务器

				
			

			

				

					05-13
				

			

		

		

			
				
前言
:sunflower: :blossom: :tulip:
高并发处理
每个Node.js进程只有一个主线程在执行程序代码，形成一个执行栈（execution context stack)。
主线程之外，还维护了一个"事件队列"（Event queue）。当用户的网络请求或者其它的异步操作到来时，node都会把它放到Event Queue之中，此时并不会立即执行它，代码也不会被阻塞，继续往下走，直到主线程代码执行完毕。
主线程代码执行完毕完成后，然后通过Event Loop，也就是事件循环机制，开始到Event Queue的开头取出第一个事件，从线程池中分配一个线程去执行这个事件，接下来继续取出第二个事件，再从线程池中分配一个线程去执行，然后第三个，第四个。主线程不断的检查事件队列中是否有未执行的事件，直到事件队列中所有事件都执行完了，此后每当有新的事件加入到事件队列中，都会通知主线程按顺序取出交EventLoop处理。当有事件执

			
		

	





	

		

			

				
					
Restful API规范及实践

				
			

			

				

					zhaoyang10的专栏
				

				

					09-16
					
					609
					
				

			

		

		

			
				
1.定义
1.1 RESOUCE（资源）
对象的单个实例。 例如，一只动物。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URI（统一资源定位符）指向它，每种资源对应一个特定的URI。要获取这个资源，访问它的URI就可以，因此URI就成了每一个资源的地址或独一无二的识别符。
1.2 URI
URI只代表资源的实体，不代表它的形式。严格地说，有些网址最后的".h...

			
		

	





	

		

			

				
					
Express接口综合案例（创建项目、配置常用中间件、路由设计、提取控制器模块、配置错误统一处理中间件、用户注册的数据验证，密码加密）

				
			

			

				

					zep
				

				

					08-03
					
					609
					
				

			

		

		

			
				
一、创建项目



二、目录结构



三、配置常用中间件
3.1 解析请求体

express.json（）
express.urlencoded（）

3.2 日志输出

morgan（）


3.3 为客户端提供跨域资源请求

cors（）



四、路由设计
本项目的接口设计参考：https://github.com/gothinkster/realworld/tree/master/api

router/index.js:
const express = require('express')



			
		

	





	

		

			

				
					
express接口

				
			

			

				

					qq_48795482的博客
				

				

					05-10
					
					1040
					
				

			

		

		

			
				
1.get接口：通过req.query可以拿到客户端发过来的参数

2.post接口：通过req.body可以拿到客户端提交的表单数据

注意：正常编写的接口，不支持跨域。可以引入第三方中间件cors，注册为全局中间件解决问题。

cors原理：通过配置响应头可以解决浏览器的跨域限制。cors只需要在服务器端配置，浏览器端不需要做任何配置。cors具有兼容性问题，并不是所有版本的浏览器都支持cors。

3.常见cors响应头。

通过res.setHeader()进行设置，常见的响应头有Access-Co

			
		

	





	

		

			

				
					
Express编写接口

				
			

			

				

					zhang1509123907的博客
				

				

					02-07
					
					615
					
				

			

		

		

			
				
// 导入express模块
const express = require('express')
// 创建express的服务器实例
const app = express()

//配置解析表单数据的中间件
app.use(express.urlencoded({extended: false}))

//必须在配置cors中间件之前，配置JSONP的接口
app.get('/api/jsonp', (req, res) => {
//    TODO：定义JSONP接口具体的实现过程
// .

			
		

	





	

		

			

				
					
使用express搭建简单接口

				
			

			

				

					Cheryl的加工厂
				

				

					11-07
					
					383
					
				

			

		

		

			
				
配置文件

npm init


安装express和axios

npm install express --save
npm install axios --save


配置index.js文件

const express = require('express')
const app = express()
const axios = require('axios')
// 路由
app.get('/', (req, res) => {
  res.send('返回数据的api服务器')
}.

			
		

	





	

		

			

				
					
MySQL基本操作

				
			

			

				

					weixin_44892365的博客
				

				

					11-28
					
					805
					
				

			

		

		

			
				
MySQL基本操作

			
		

	





	

		

			

				
					
通过express实现restfulapi

				
			

			

				

					m0_37716271的博客
				

				

					05-17
					
					1041
					
				

			

		

		

			
				
在express中给router设置不同的请求接口实现restful规范
express实现后端渲染

app.js配置router
router通过api传数据给ejs渲染模板
ejs实现静态和动态的页面渲染

router通过api传数据
前端请求方式

get
post
put
delete
head
all


以上的请求方式统称为： restful api


通过restful api...

			
		

	





	

		

			

				
					
RESTful接口设计规范与命名规则详解

				
			

			

				

					
				

			

		

		

			
				
"RESTful接口设计规范"  RESTful接口是一种遵循特定规则的API设计方法，全称为Representational State Transfer，即“表现层状态转移”。它是由Roy Fielding在其博士论文中提出的，主要用于构建分布式系统，特别是...

			
		

	



              




          




        



    





    



      

      

        
      

      





	

		
评论 1

	

	
	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

            领取后你会自动成为博主和红包主的粉丝
            规则
          

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

                
 1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
 2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

              

            

          

      

      余额充值