Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Speaker Deck
PRO
Sign in
Sign up for free
SwaggerでSSLCを 置き換える / Replacing SSLC with Swagger
Endo_Hizumi
September 24, 2019
Programming
0
62
SwaggerでSSLCを 置き換える / Replacing SSLC with Swagger
Replacing SSLC with Swagger
Endo_Hizumi
September 24, 2019
Tweet
Share
More Decks by Endo_Hizumi
See All by Endo_Hizumi
テレビを飲み込め! Webの嵐!! / Swallow the TV! Web storm! !!
endohizumi
1
59
OK:Googleから始めるスマートホーム生活 / OK: Smart home life starting from Google
endohizumi
0
150
クソアプリで基礎固め / Tutorial in your joke app for Vue.js
endohizumi
0
84
jQuery使いがVue.jsを使った話 / thank you jQuery,Hello Vue.js
endohizumi
0
93
スマホで始めるウェブアプリ開発 / let's start web application development with a Android Device
endohizumi
1
570
キレない関数の作り方 / How to make bat function no anger
endohizumi
0
53
Server-sent eventsを使ってみた / I tried using Server-sent event
endohizumi
1
700
キレない変数の扱い方 /How to handle variables no anger
endohizumi
0
53
Netlifyで、ポートフォリオをつくってみた
endohizumi
0
64
Other Decks in Programming
See All in Programming
CakePHPの内部実装 から理解するPSR-7
boro1234
0
180
Mobile Product Engineering
championswimmer
0
300
GitHub Actions を導入した経緯
tamago3keran
1
430
The strategies behind ddd – AdeoDevSummit 2022
lilobase
PRO
4
250
UI Testing of Jetpack Compose Apps, AppDevCon
alexzhukovich
0
160
こそこそアジャイル導入しようぜ!
ichimichi
0
1.2k
JSのウェブフレームワークで高速なルーターを実装する方法
usualoma
1
1.8k
競プロのすすめ
uya116
0
660
Terraform Plan/Apply結果の自動通知
ymmy02
0
280
BASE BANKチームの技術選定と歴史 / how to decide technology selection for startup
budougumi0617
0
960
Java初心者が知っておくべきプログラミングのこと - JJUG CCC 2022 Spring
kishida
5
540
Amazon ECSのネットワーク関連コストの話
msato
0
640
Featured
See All Featured
Product Roadmaps are Hard
iamctodd
34
6.5k
Dealing with People You Can't Stand - Big Design 2015
cassininazir
351
21k
Building an army of robots
kneath
299
40k
Statistics for Hackers
jakevdp
781
210k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
12
920
ピンチをチャンスに:未来をつくるプロダクトロードマップ #pmconf2020
aki_i
23
15k
Mobile First: as difficult as doing things right
swwweet
213
7.5k
Clear Off the Table
cherdarchuk
79
280k
Atom: Resistance is Futile
akmur
255
20k
Refactoring Trust on Your Teams (GOTO; Chicago 2020)
rmw
19
1.4k
How GitHub Uses GitHub to Build GitHub
holman
465
280k
Thoughts on Productivity
jonyablonski
43
2.3k
Transcript
SwaggerでSSLCを 置き換える #2 クーコム Tech Meetup 代官山でLT会 遠藤ヒズミ
SSLC? 2
SSLCとは? Server Side Legacy Code SSLC 3
テストも仕様書もない素のPHPでかかれたコードです ただのレガシーコードやん 4
5 今回の範囲 GameClient GameServer Jinro JinroResponcer.php Broadcast.php member activity_logs triggerで 書き込む
発言・投票などの行動 書き込み レコード 取得 JSONで送信 5 今、開発している人狼のWebアプリの仕組みがこうなって います。
6 今回の範囲 GameClient GameServer Jinro JinroResponcer.php Broadcast.php member activity_logs triggerで 書き込む
発言・投票などの行動 書き込み レコード 取得 JSONで送信 6 クライアントからデータを受け取る部分の作業を 内容を話します
今回の範囲 ちなみに、逆にサーバーからリアルタイムに配信する側 https://speakerdeck.com/endohizumi/i-tried-using-server-sent-event 7
置き換えるまで経緯 • クライアント側を実装中にサーバー側に必要な機能が出てきた • サーバー側のコードを昔の記憶(3年くらい前)を元に読んでみた ◦ 考えとしては、クライアントの要求でリソースの操作を行う ◦ POSTメソッドのみ($_POSTで取得) ◦
RequestBodyのcategoryパラメータの値で12分岐 ◦ pdoのprepareメソッドを実行の行がほとんど ◦ 一部の分岐で関数を呼んでいる ◦ 分岐の後に、SQLクエリを実行する ◦ categoryの値によってクエリの結果を取得する ◦ 返す結果がないときは、exit()で終了 8
置き換える対象 • サーバー側のコードを昔の記憶(3年くらい前)を元に読んでみた ◦ クライアントの要求でリソースの操作を行うWebAPIの様なもの ◦ MVCもなくモノシリック ◦ $_POSTで取得しているため、リスキー ◦
仕様書もなくコードを読むしかない あれ、これ、よくないコードでは? 9
自分のモチベーションと要求を満たす一手 • ドキュメントも欲しい • 良くないコードも直したい(書き直したい) 10
自分のモチベーションと要求を満たす一手 • ドキュメントも欲しい • 良くないコードも直したい(書き直したい) どちらも自力でやるには、モチベーションの維持が難しい 11
自分のモチベーションと要求を満たす一手 • ドキュメントも欲しい • 良くないコードも直したい(書き直したい) どちらも自力でやるには、モチベーションの維持が難しい ➡ そのためのSwagger 12
Swaggerがなぜ良いのか • yml形式でかけて、HTML形式のドキュメントを生成できる • ドキュメントがクライアントとして動く • フレームワークを使ったコードが生成できる ➡ ドキュメントもコードも書けて、一挙両得! 13
Swaggerファイルを書くために 1. 役割と入出力を考える 14
Swaggerファイルを書くために 2. エンドポイントの命名 対象とするテーブル名をもとに、エンドポイントを名付ける memberテーブルを操作する処理 → /members/配下に roomテーブルを操作する処理 → /rooms/配下に
15
Swaggerファイルを書くために 3. 短いURLを目指す 役職の取得APIエンドポイント /members/{userName}/job/ /jobs/{userName} プレイヤー以外に役職つけないから /members/は長くないか? 16
いざ、記述 17
コード生成 18
感想 使ってどうだったか • 苦しんでymlを書いたのは、初めてでした(泣 • Swagger Editorが、VBAエディタ並みの不親切なエラーしか出して くれないのが、辛かった。 • しかし、コードを生成してくれたので、助かった。
19