全栈工程师-后端开发-RESTful API_实战：构建一个RESTfulAPI.docxVIP

PAGE1

PAGE1

RESTfulAPI基础

1RESTfulAPI概念与原则

REST（RepresentationalStateTransfer）是一种网络应用程序的设计风格和开发方式，基于HTTP协议，可以使用XML或者JSON格式传输数据。RESTfulAPI设计遵循以下原则：

无状态：每个请求都包含理解请求所必需的全部信息，服务器不存储客户端状态。

客户端-服务器：架构清晰，客户端负责用户交互和显示，服务器负责数据存储和业务逻辑。

缓存：响应可以被缓存，以减少网络延迟和服务器负载。

统一接口：通过标准的HTTP方法（GET,POST,PUT,DELETE等）操作资源。

1.1示例：使用Flask构建RESTfulAPI

fromflaskimportFlask,jsonify,request

app=Flask(__name__)

#模拟数据

books=[

{id:1,title:Python编程,author:MarkLutz},

{id:2,title:深入浅出计算机组成原理,author:王爽},

{id:3,title:算法导论,author:ThomasH.Cormen}

]

@app.route(/api/books,methods=[GET])

defget_books():

returnjsonify(books)

@app.route(/api/books/int:book_id,methods=[GET])

defget_book(book_id):

book=next((bookforbookinbooksifbook[id]==book_id),None)

ifbook:

returnjsonify(book)

else:

returnjsonify({error:Booknotfound}),404

@app.route(/api/books,methods=[POST])

defadd_book():

new_book=request.get_json()

books.append(new_book)

returnjsonify(new_book),201

@app.route(/api/books/int:book_id,methods=[PUT])

defupdate_book(book_id):

book=next((bookforbookinbooksifbook[id]==book_id),None)

ifbook:

data=request.get_json()

book.update(data)

returnjsonify(book)

else:

returnjsonify({error:Booknotfound}),404

@app.route(/api/books/int:book_id,methods=[DELETE])

defdelete_book(book_id):

globalbooks

books=[bookforbookinbooksifbook[id]!=book_id]

return,204

if__name__==__main__:

app.run(debug=True)

1.2解释

GET：获取资源，如获取所有书籍或特定书籍的信息。

POST：创建资源，如添加新书。

PUT：更新资源，如修改书籍信息。

DELETE：删除资源，如删除书籍。

2HTTP方法与资源操作

HTTP方法用于指示对资源的操作类型：

GET：请求获取指定资源。

POST：用于创建资源。

PUT：用于更新资源，通常需要提供完整的资源信息。

DELETE：用于删除资源。

2.1示例：使用HTTP方法操作资源

#使用curl发送GET请求获取所有书籍

curl-XGEThttp://localhost:5000/api/books

#使用curl发送GET请求获取特定书籍

curl-XGEThttp://localhost:5000/api/books/1

#使用curl发送POST请求添加新书

curl-XPOST-HContent-Type:application/js