六步实现Rest风格的API

Rest的作者认为计算机发展到现在,最大的成就不是企业应用,而是web,是漫漫无边的互联网web世界。Web能有这么大的成就,它值得我们研究。所以Rest的作者仔细研究了Web,按照Web的世界一些关键特性,提出了我们在实现企业应用的时候应该遵循的一种风格,就是Restful。

Rest风格的API可以给我们很多好处,比如:简洁,统一,性能,可扩展性等等。可惜的是,在实现Rest的时候,总有一些Rest的关键特性没有实现,比如,无状态性,这在我做过的两个项目和我知道的另外一个项目都存在。事实上要实现无状态性在java里不是那么容易,因为那意味着要把servlet的session抛弃了。除此之外,Rest的一些其他特性在各个项目中实现的也是各有不同。

接下来,我会列出一些我认为的,要实现Rest风格API的关键步骤:


1. 所有东西都是资源(Resource)

所有要给API操作的对象都只能是资源。不管实际上存在的,还是抽象上的。所有资源都会有一个不变的标识(ID),对资源的任何API操作都不应该改变资源的标识。资源和其他资源会有关系,资源与资源的关系通过资源的标识来引用。对资源的操作都应该是完整的,比如获取资源拿到的应该是一个完整的资源对象(根据企业引用特点有些例外,后面会提到)。

事实上,上面的这些完完全全是按照互联网的特性提出来的。互联网中,一个URL就是一个资源;资源的内容就是HTML页面;不管怎么改HTML内容,URL都不会改变;资源之间通过HTML里的连接联系起来;每次获取的时候,获取到的都是完整的HTML内容。

假设有一个博客系统,那么其中的资源可以包括:博主,每个博主都是一个资源;博客,每篇博客都是一个资源,博客和博主之间有联系,通过ID联系起来;每篇博客都会有回复,回复也算是资源,但是它是隶属于博客的,可以认为回复是博客的子资源(你也可以认为博客是博主的子资源,怎么抽象取决于具体的应用,这里不讨论)。

这步通常不难实现,因为这和ORM中的对象概念是类似的,实现上,如果用了Hibernate之类的框架,改动也应该很小。


2. 规范对资源的操作,最好只包括CRUD

CRUD指创建(Create),读取(Read), 更新(Update),删除(

  • 11
    点赞
  • 38
    收藏
    觉得还不错? 一键收藏
  • 4
    评论
好的,首先你需要搭建一个GO的后端服务,可以使用gorilla/mux等框架来实现restful API,然后使用Svelte来开发前端页面。 以下是一个简单的示例: 1. 首先,你需要创建一个GO项目并安装gorilla/mux框架: ```go go mod init example.com/myproject go get -u github.com/gorilla/mux ``` 2. 创建一个路由处理程序来处理API请求: ```go package main import ( "encoding/json" "log" "net/http" "github.com/gorilla/mux" ) type User struct { ID string `json:"id"` Username string `json:"username"` Email string `json:"email"` } var users []User func main() { router := mux.NewRouter() router.HandleFunc("/api/users", getUsers).Methods("GET") router.HandleFunc("/api/users/{id}", getUser).Methods("GET") router.HandleFunc("/api/users", createUser).Methods("POST") router.HandleFunc("/api/users/{id}", updateUser).Methods("PUT") router.HandleFunc("/api/users/{id}", deleteUser).Methods("DELETE") log.Fatal(http.ListenAndServe(":8000", router)) } func getUsers(w http.ResponseWriter, r *http.Request) { json.NewEncoder(w).Encode(users) } func getUser(w http.ResponseWriter, r *http.Request) { params := mux.Vars(r) for _, user := range users { if user.ID == params["id"] { json.NewEncoder(w).Encode(user) return } } json.NewEncoder(w).Encode(&User{}) } func createUser(w http.ResponseWriter, r *http.Request) { var user User _ = json.NewDecoder(r.Body).Decode(&user) users = append(users, user) json.NewEncoder(w).Encode(user) } func updateUser(w http.ResponseWriter, r *http.Request) { params := mux.Vars(r) for index, user := range users { if user.ID == params["id"] { users[index] = User{ ID: user.ID, Username: user.Username, Email: user.Email, } json.NewEncoder(w).Encode(users[index]) return } } } func deleteUser(w http.ResponseWriter, r *http.Request) { params := mux.Vars(r) for index, user := range users { if user.ID == params["id"] { users = append(users[:index], users[index+1:]...) break } } json.NewEncoder(w).Encode(users) } ``` 3. 接下来,你可以使用Svelte来创建前端页面: ```html <!-- App.svelte --> <script> let users = []; async function getUsers() { const response = await fetch('/api/users'); users = await response.json(); } </script> <button on:click={getUsers}>Get Users</button> <ul> {#each users as user} <li>{user.username} ({user.email})</li> {/each} </ul> ``` 4. 最后,你需要将GO后端和Svelte前端连接起来。你可以通过将Svelte打包为静态文件并将其放置在GO的public目录中来实现此目的,然后在GO的main函数中添加以下代码: ```go fs := http.FileServer(http.Dir("public")) http.Handle("/", fs) ``` 现在你可以启动GO程序并访问http://localhost:8000 来访问前端页面和API了。
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值