FiNCのWeb API開発事情

I explained how FiNC Developer implement APIs.
What gems and what development process we use.
We switched api gems from grape and rabl to ApplicationController and ActiveModelSerializer.
I explained why and its pros/cons.

1. 'J/$w8FC"1*‰CÄ Ø
'J/$*OD4IJOP[VLB'VNJZB

2. \wC¯p˜T”\q
w3BJMTpw"1*‰CwMO
w3BJMTw"1*‰Ct–˜•”(b(FN
w'J/$pw"1*‰Cwv•

3. ×ü
wðé™û !TIJOPGVNJKQ
w±”̱ Å¤ï´Çž
wå'J/$Öþ p̤ï´Çž
w'J/$žÓæw€\T’‡p›_oV‡`h

4. FiNC
wÔçµ­žwžÓæ­”³ãC`oM‡b

5. FiNC = Microservices
w.JDSPTFSWJDFT›>;`oM‡b
IUUQTEFWPUUPEFTDBMJOHXJUINJDSPTFSWJDFTBOEWFSUJDBMEFDPNQPTJUJPO

6. MicroservicesqMQy
"1*

7. ÔxAPI‰Cwé›`‡b
d"MMUFBNTXJMMIFODFGPSUIFYQPTFUIFJSEBUBBOE
GVODUJPOBMJUZUISPVHITFSWJDFJOUFSGBDFTd
+F$Ž#F[PT

8. RailspwAPI‰CrO`oM‡b

9. API‰Cpx7‘sU|òèq¬R¶UK”
w"1*Ñè”Ü딫
w+40/³æžå ²”
wÅ©áÝïÄ
w嵀
wÞ¿«"1*

10. FiNCp s8t>;`oMhMO
w"1*Ñè”Ü딫
w(SBQF
w+40/³æžå ²”
wSBCM
wÅ©áÝïÄ\R
w4XBHHFS

11. w"1*Ñè”Ü딫
w(SBQF"QQMJDBUJPO$POUSPMMFS
w+40/³æžå ²”
wSBCM"DUJWF.PEFM4FSJBMJ[FS
wÅ©áÝïÄ\R
w4XBHHFS+40/4DIFNB QSNEDPNNJUUFF
FiNCpqO>;`oM”MO

12. w"1*Ñè”Ü딫
w生ï¬Ñ ç›G \`sMp‹Úò$t¤ïÅÙ ïÄ
U {Z”
wIUUQTHJUIVCDPNSVCZHSBQFHSBQF
Grape
module V1
class UsersApi < Grape::API
resource :users do
params do
requires :id, type: Integer
end
get '/:id', rabl: '/v1/users/index' do
@users = User.limit(10)
end
params do
requires :id, type: Integer
optional :name, type: String
end
patch '/:id', rabl: '/v1/users/show' do
@user = User.create(user_params)
end
end
end
end

13. w+40/³æžå ²”
w ×w%4-pèµÙïµw[UpV”
w JÈsG \UpV”
wIUUQTHJUIVCDPNOFTRVFOBSBCM
rabl
object @user
attributes :id, :name, :created_at, :updated_at
{
"id": 1,
"name": "shinofumijp",
"created_at": "2017-02-02T10:13:52.000+09:00",
"updated_at": "2017-02-02T10:13:52.000+09:00"
}

14. wÅ©áÝïÄ׈\Rqîæ¥w;™
w"1*[T’׈pÅ©áÝïÄqî楛;™pV”
wIUUQTHJUIVCDPNSVCZHSBQFHSBQFTXBHHFS
Swagger

15. se ГõQhwT
w(SBQFiq
wIˆÌU OM
w ×w%4-›®Q”žAUK”
wGOpMq\–‹ «ÉµÄUMqV
w³ïÓçt"QQMJDBUJPO$POUSPMMFS›b;b”\qt

16. se ГõQhwT
w(SBQFSBCMx JÈaWh
w"1*]qtèµÙïµUy’y’tslh
wæ¹”µ¦²›ÇTdhM
w"DUJWF.PEFM4FSJBMJ[FSq+40/4DIFNBpr>

17. se ГõQhwT
w4XBHHFSp\R^•”Å©áÝïÄpx ØCU“sM
w4b”hŠt8JLJ› {Vb”Uzî÷qm`h
wDPNNJUUFF +40/4DIFNBpr>

18. ²”V 4ƒ

19. Ôéb\q
w'J/$p–loM”"1*U [
w'J/$pw3BJMT"1*‰CÑé”

20. ActiveModelSerializer
w+40/³æžå ²”;w(FN
w«åµp¦b”hŠæ¹”µ¦²t²MoM”
wIUUQTHJUIVCDPNSBJMTBQJBDUJWF@NPEFM@TFSJBMJ[FST
# either
class SomeResource < ActiveRecord::Base
# columns: title, body
end
# or
class SomeResource < ActiveModelSerializers ::Model
attributes :title, :body
end
class SomeSerializer < ActiveModel::Serializer
attribute :title, key: :name
attributes :body
end
{
"name": "namevalue",
"body": "bodyvalue"
}

21. JSON Schema
w+40/›;MoÔ»›G \b”Üwm
wIUUQKTPOTDIFNBPSH
\
UJUMF&YBNQMF4DIFNB
UZQFPCKFDU
QSPQFSUJFT\
pSTU/BNF\
UZQFTUSJOH
^
MBTU/BNF\
UZQFTUSJOH
^
BHF\
EFTDSJQUJPO"HFJOZFBST
UZQFJOUFHFS
NJOJNVN
^
^
SFRVJSFE<pSTU/BNFMBTU/BNF>
^

22. JSON Schemapî÷qwmUsXs”wxse
wDPNNJUUFF
w+40/4DIFNB›it
w櫤µÄ~èµÙïµw½£¿«
wµÄpèµÙïµw½£¿«
wIUUQTHJUIVCDPNJOUFSBHFOUDPNNJUUFF

23. JSON Schema {XwŠœrMwpx
wQSNE
w:".-p {Zo+40/qÚ”«¼¢ïÅ©áÝïÄw\RUDó
wIUUQTHJUIVCDPNJOUFSBHFOUQSNE

24. ‡qŠ”q\œsòa
Z/DPNNJUUFFQSNEp+40/4DIFNB›MMòatá;b”SShwú”
IUUQTPUBZDPNCMPHpODBEWFOU

25. îMwî÷ q
'h ƒ- î÷ 2" æ攵

26. JSON Schema›[
w:".-p[› {Mo+40/qÚ”«¼¢ïÅ©áÝïÄ›\R
w«å žïĤï´Çžt\R`hÅ©áÝïÄ›ž
"$schema": http://json-schema.org/
draft-04/hyper-schema
title: Daily Steps Count
description: Daily Steps Count Resource
stability: prototype
strictProperties: true
type:
- object
definitions:
date:
description: date (JST)
example: "2016-11-01"
type: string
KTPO
NE

27. ((?) JSON Schema + prmd?;tips
wbptá;`oM”pßè«ÄæÏRt„›ð‡d”‹ —
sXsMxc{
w'J/$pxSFTPVSDFTqBQJTtüZoá;`oM”{
wSFTPVSDFTæ¹”µ[›G \{BQJTT’€ °^•”;
wBQJT"1*[›G \{櫤µÄèµÙïµ[pSFTPVSDFT›b;
b”\qp"1* ×w¤ïŸŸU\‡•sM‘Ot`oM”{«Ž
x???{
docs/
!"" schema
#"" meta.yml
#"" schema.json
#"" schema.md
!"" schemata
#"" apis
!"" resources

28. Controllert??????[
w› b”\qsMlb
class DailyStepsController < ApplicationController
def show
steps = DailyStep.where(user_id: current_user.id)
render json: steps
end
end

29. w?????x???p[b”
w"DUJWF.PEFM4FSJBMJ[FSx³æžå ¶^•”«åµ›Ibwp
³æžå ¶iwÞÃç›×^b”\q‹K”
w«ó:w"3ÞÃçt‡hU”qV
w«Ã¯è”»w‘OtÞÃ盦Á`hMqV
ActiveModelSerializerpèµÙïµ›[
class DailyStepSerializer < ActiveModel::Serializer
attributes :id, :date, :step
end

30. µÄpÌæÔ³ãï¬Ý
wXJMMOFUDPNNJUUFFSBJMT›–Qy34QFDp
BTTFSU@TDIFNB@DPOGPSNU–Q”
wÞ34QFDp+40/4DIFNBqSFTQPOTFCPEZU°•`oM”T›???
pV”
wIUUQTHJUIVCDPNXJMMOFUDPNNJUUFFSBJMT
it 'returns expected response ' do
expect(response.status).to eq 200
json = JSON.parse(response.body)
expect(json['id']).to be_kind_of Integer
expect(json[‘step']).to be_kind_of Integer
end
it 'returns expected response ' do
expect(response.status).to eq 200
assert_schema_conform
end

31.  æ`hAL
w±”Ì«å žïÄpw"1*wÝÝ%*Un’dh
wÅ©áÝïÄ›î÷²tžpV”\qp‰C®pU ÍUlh
wÅ©áÝïÄUÌæÔ³ãï›`oX•”wpÝïÂ^•”‘O
tslh
wæ¹”µ¦²U`zèµÙïµÜU†`h

32. ’”]J
w׈\R^•hÅ©áÝïÄU¡ˆn’M
w櫤µÄÍåÝ”»wT’«åµw!õ
w¤Ú «é±”ϵtüT•hÅ©áÝïÄwg›mw63-t

33. OSStuÃ$t¯Û¿Ä
wb;`oM”(FN›–MbXb”hŠt13›ùlh“z(FN›
^loM‡b
wIUUQTHJUIVCDPNJOUFSBHFOUQSNEQVMM

34. ™r>`hM\q
w"1*«å žïÄw׈\R
wIUUQTHJUIVCDPNJOUFSBHFOUIFSPJDTqT
wÌ”´ãÇï¬0
w¤å”èµÙïµwžè=
wIUUQTUPPMTJFUGPSHIUNMSGD›€ßt

35. ;
w'J/$žÓ曑–`XS&M`‡b‚
w Ÿ4¯”ÅTIJOPpODKQpž§¢ïÄJåpV‡b

36. K“UqO]_M‡`h‚
'J/$px±”̱ Å¤ï´Çž›7 B`oM‡b