CMAPI五輪書は、クラスメソッドにおける Web API のエンジニアリングに関する基本的な考え方および標準を定義するもので、技術的なさまざまな原則やガイドライン集です。 似たようなガイドラインは他にもありますが、本書は RESTful Web API / Java / Spring Framework / AWS という構成のシステムにスコープを絞り、より詳細に踏み込んだドキュメントを目指しています。目指しています！？ 地の巻 - システム開発と全体的な話題【進捗90%】 水の巻 - API 外部仕様【進捗95%】 火の巻 - Java による内部実装【進捗40%】 風の巻 - AWS によるサーバー環境インフラ設計と SRE【進捗1%】 空の巻 - Java on AWS サーバー環境システム運用【進捗5%】 というわけで、実は「未完の書」なのですが、それでもすべてをお話するには時間が足りません。しかし、これまでの執筆にあたって非常に興味深いトピックがいくつも生まれましたので、それらをピックアップしてご紹介したいと思います。

3. #cmdevio2018
✦
✦
✦
✦
✦
✦
✦
✦
Twitter @daisuke_m

4. ✦
✦
✦
✦
✦

6. #cmdevio2018
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦
✦

7. #cmdevio2018
✦
✦
✦
✦
✦
✦
✦
✦
total
40 min
5

8. API

9. #cmdevio2018
✦
✦
✦
✦
✦
AWS

10. #cmdevio2018
✦
.oO ( Add, Remove, BatchGet )

11. #cmdevio2018
✦
✦
✦
✦
✦
✦

12. #cmdevio2018
✦
✦
✦
✦

13. #cmdevio2018
✦
✦
✦
✦
✦
✦

14. URL
HTTP

15. #cmdevio2018
✦
✦
✦
✦
✦
✦
✦
✦
✦

16. #cmdevio2018
foo://example.com:8042/over/there?name=ferret#nose
_/ ______________/_________/ _________/ __/
| | | | |
scheme authority path query fragment
| _____________________|__
/ /
urn:example:animal:ferret:nose

17. #cmdevio2018
/depts
/depts/{dept_code}
/emps
/emps/{emp_code}
/depts/{dept_code}/emps
/depts/{dept_code}/emps/{emp_code}
=Entire collection path =Specific item path

18. #cmdevio2018
✦ GET ls cat
✦ PUT
✦ PATCH sed awk
✦ DELETE rm
✦ POST

19. #cmdevio2018
✦
.
|-- depts
| |-- dev
| | `-- emps
| | |-- ezaki
| | `-- kanou
| |-- admin
| | `-- emps
| | `-- ushijima
| `-- sales
| `-- emps
`-- emps
|-- ezaki
|-- kanou
`-- ushijima
$ cat /emps/ezaki
{
"emp_code": "ezaki",
"name": " ",
...
}
$ ls /depts/sales/emps
[
"ushijima"
]

20. #cmdevio2018
GET
PUT
PATCH
DELETE
POST

21. #cmdevio2018
PUT /depts/acct
{
"dept_code": "acct",
"name": "Accounting"
}
200 OK or 201 Created
( )
POST /depts
{
"dept_code": "acct",
"name": "Accounting"
}
200 OK or 409 Conflict
( )
PUT
Dept
POST
Dept
CreateDeptRequest
echo "{...}" >/depts/acct execute create_dept({...});

22. #cmdevio2018
GET /depts/sales/emps
200 OK
GET /depts/research
DELETE /depts/research
GET /depts/research/emps
etc...
404 Not Found
POST /depts
{
"dept_code": "research",
"name": "Research"
}
200 OK
POST /depts
{ "dept_code": "research" }
400 Bad Request
404 400

23. #cmdevio2018
orders.create({
"id": 10
});
POST /orders
{
"id": 10
}

24. #cmdevio2018
✦
✦ GET /emp/ezaki
✦ GET /emp?lang=zh_CN
✦
orders["a"].cancel({
"x": "a",
"y": "b"
});
POST /orders/_cancel?x=a
{
"y": "b"
}

25. #cmdevio2018
GET
POST
PUT
PATCH
DELETE
Query

26. #cmdevio2018
GET /depts
POST /depts
GET /depts/{dept_code}
POST /depts/{dept_code}
PATCH /depts/{dept_code}
PUT /depts/{dept_code}
DELETE /depts/{dept_code}

27. #cmdevio2018
GET /emps
POST /emps
GET /emps/{emp_code}
POST /emps/{emp_code}
PATCH /emps/{emp_code}
PUT /emps/{emp_code}
DELETE /emps/{emp_code}

29. #cmdevio2018
{
"emp_code": "foo",
"name": "Stewart Copeland",
"tel": "00-1111-2222",
"salary": 12345678,
"dept_code": null
}
{
"emp_code": "foo",
"name": "Stewart Copeland",
"dept_code": null
}
ex.
1 API

30. #cmdevio2018
✦
✦
✦
✦
✦
✦
Serialized form

31. #cmdevio2018
✦
✦
✦
✦
✦
✦

32. #cmdevio2018
POST /emps/{emp_code}
POST /emps/{emp_code}
GET /emps
GET /emps/{emp_code}

33. #cmdevio2018
✦
✦ _
✦
✦ POST /emps/{emp_code}/_update-salary
✦ POST /emps/{emp_code}/_update-profile
✦ GET /emps/_for-public
✦ GET /emps/{emp_code}/_for-public
POST_update-salary
POST_update-profile
GET_for-public
GET_for-public

34. #cmdevio2018
POST /emps/{emp_code}/_update-salary
POST /emps/{emp_code}/_update-profile
GET /emps/_for-public
GET /emps/{emp_code}/_for-public

35. CQRS ( )

36. #cmdevio2018
✦

37. #cmdevio2018
✦

38. #cmdevio2018
✦
✦
✦
✦
✦
✦

39. #cmdevio2018
✦
✦
✦
✦
: CQRS PK Command

40. #cmdevio2018
2 Command Query

41. #cmdevio2018
✦
✦ POST
✦
POST /query/depts
POST /query/emps