kbc-itw / BookChain

図書貸し借りシステム
MIT License
4 stars 4 forks source link

Web API設計 #27

Closed Huruikagi closed 6 years ago

Huruikagi commented 6 years ago

概要

クライアント(今回の場合はWebブラウザ)に公開する、APIの仕様を策定する。 多分Restっぽく作る。

目的

実装前の仕様策定。

Huruikagi commented 6 years ago

個人的に、WordpressのREST APIのドキュメントが一番読みやすかったので、これをパクる。 https://developer.wordpress.org/rest-api/reference/

とりあえずルートページは作るだけ作った。 https://github.com/kbc-itw/BookChain/wiki/BookChain-web-API

Huruikagi commented 6 years ago

GraphQL はまだ我々には早いと思うので、今回は実装は見送る。

よって、素直に REST ベースでAPI設計を行う。

その上で、HATEOAS は取り入れるべきか否か?

Springがなんかサポートしているし、割とメンテされている。 https://spring.io/understanding/HATEOAS http://projects.spring.io/spring-hateoas/

分散型でこそ価値のある設計思想だと思うが、どうしようかな。

Huruikagi commented 6 years ago

http://assets.spring.io/wp/WebSocketBlogPost.html

Huruikagi commented 6 years ago

だいたい書き終わった。