韓国語 2024/09/20（金）
シチュエーション: OpenAPIについて話す (オープンエーピーアイエ テヘソ イヤギハダ)
ペルソナ Aさん: バックエンド開発者。APIドキュメンテーションの改善方法を探している。 Bさん: フロントエンド開発者。OpenAPIの経験が豊富で、その利点をよく理解している。
A: OpenAPI에 대해 들어봤는데, 정확히 뭔지 잘 모르겠어요. (オープンエーピーアイエ テヘ トゥロボヌンデ、チョンファキ ムォンジ チャル モルゲッソヨ。) OpenAPIについて聞いたことがありますが、正確に何なのかよく分かりません。
B: OpenAPI는 RESTful API를 설명하고 문서화하는 표준 방식이에요. (オープンエーピーアイヌン レストフル エーピーアイルル ソルミョンハゴ ムンソファハヌン ピョジュン バンシギエヨ。) OpenAPIはRESTful APIを説明し、文書化する標準的な方法です。
A: 그렇군요. 우리 API 문서화에 도움이 될까요? (クロックンヨ。ウリ エーピーアイ ムンソファエ トウミ デルッカヨ？) なるほど。私たちのAPI文書化に役立ちますか？
B: 네, 많은 도움이 돼요. API의 엔드포인트, 파라미터, 응답 형식 등을 명확하게 정의할 수 있어요. (ネ、マヌン トウミ デヨ。エーピーアイエ エンドゥポイントゥ、パラミト、ウンダプ ヒョンシク トゥングル ミョンファカゲ チョンエハル ス イッソヨ。) はい、とても役立ちます。APIのエンドポイント、パラメータ、レスポンス形式などを明確に定義できます。
A: 그럼 프론트엔드 개발자들도 쉽게 이해할 수 있겠네요? (クロム プロントゥエンドゥ ケバルジャドゥルド シプゲ イヘハル ス イッケンネヨ？) それならフロントエンド開発者も簡単に理解できそうですね？
B: 맞아요. 게다가 자동으로 클라이언트 코드도 생성할 수 있어요. (マジャヨ。ケダガ チャドンウロ クライオントゥ コドド センソンハル ス イッソヨ。) そうです。さらに、自動的にクライアントコードも生成できます。
A: 와, 정말 유용하네요. 어떻게 시작하면 좋을까요? (ワ、チョンマル ユヨンハネヨ。オットケ シジャカミョン チョウルッカヨ？) わあ、本当に有用ですね。どのように始めればいいでしょうか？
B: Swagger Editor로 시작하는 게 좋아요. YAML이나 JSON으로 API를 정의할 수 있어요. (スワッガー エディトロ シジャカヌン ゲ チョアヨ。ヤムルイナ ジェイソンウロ エーピーアイルル チョンエハル ス イッソヨ。) Swagger Editorで始めるのがいいですよ。YAMLやJSONでAPIを定義できます。
A: 알겠어요. 한번 시도해 볼게요. 팀 전체의 생산성이 높아질 것 같아요. (アルゲッソヨ。ハンボン シドヘ ボルゲヨ。ティム チョンチェエ センサンソンギ ノパジル コッ カタヨ。) 分かりました。一度試してみます。チーム全体の生産性が上がりそうです。
B: 그래요. 꼭 궁금한 점 있으면 물어보세요. (クレヨ。コク クンクムハン チョム イッソミョン ムロボセヨ。) そうですね。何か疑問があれば、ぜひ聞いてくださいね。
単語集
문서화 (ムンソファ): 文書化
코딩 (コディング): コーディング
표준 (ピョジュン): 標準
규격 (キュギョク): 規格
엔드포인트 (エンドゥポイントゥ): エンドポイント
주소 (チュソ): アドレス
파라미터 (パラミト): パラメータ
변수 (ビョンス):変数
응답 (ウンダプ): レスポンス
요청 (ヨチョン): リクエスト
정의하다 (チョンエハダ): 定義する
설명하다 (ソルミョンハダ): 説明する
생성하다 (センソンハダ): 生成する
만들다 (マンドゥルダ)
作る 유용하다 (ユヨンハダ): 有用だ
쓸모없다 (ッスルモオプタ): 無駄だ
생산성 (センサンソン): 生産性
효율성 (ヒョユルソン): 効率性
文法の解説
- '-ㄹ/을 수 있다': 「～することができる」という可能性や能力を表す表現です。例えば、'정의할 수 있어요'（定義することができます）のように使います。
- '-아/어 보다': 「～してみる」という試行を表す表現です。'시도해 볼게요'（試してみます）のように使用されています。
最後に、関連するシチュエーション3個はこちらです。明日はこちらで学んでください。 ・RESTful APIの設計原則について議論する ・API版本管理の戦略を立てる ・APIセキュリティの実装方法について相談する