ユアマイスター株式会社エンジニアブログ

ユアマイスター株式会社のエンジニアが日々徒然。

APIを知らなかった私が実装できるようになるまで学んだこと

こんにちは。エンジニアインターンの土屋です。
今日はAPIの実装の流れについて書きたいと思います。
また、1から実装していく中でプログラミングにおいて大切だと学んだことがあります。
是非、エンジニアインターン、初心者の方は参考にして欲しいです。

APIとは。。?

API(アプロケーションプログラミングインターフェース)とは、プログラムの関数の様なもの。プログラムからソフトウェアを繋ぐためのインターフェースです。

まずインターフェースとは何かと言うと、「何かと何かを繋ぐもの」簡単に言えば自動販売機の様なものです。

人とその人が欲しい飲み物を繋ぐもので、お金を入れて飲みたいジュースのボタンを押すだけで飲み物が出てくる

f:id:yourmystar_engineer:20170612231309p:plain

同じ様にAPIは「アプリケーションに情報や指示を出してプログラミングしてくれる」ものです。

request定義

APIを実装する際には、手順があり、私のようなエンジニアインターンやエンジニア初心者の方は書いてみるといいと思います。 request定義はフォーマット(どのような形でデータを送信するか)とURLを決めます。APIのフォーマットではXMLまたはJSONがスタンダードになっています。

response定義

response定義では実際に返したい値を決めたフォーマットの形でかき、画面に出力したいデータを決めておきます。
正常値だけではなくて、エラー値も決めておきます

    {
          "result": 400,
          "reviews" []
    }

設計

  1. リクエストパラメータを受け取る

  2. リクエストのnullチェック
    ・ リクエストパラメータで受け取った値が存在しているかチェックを行う

  3. 形式チェック
    ・ 値がどんな形式で入ったら正常なのかチェックを行う

  4. DBを検索
    ・ 画面に表示したいデータから対象テーブルを洗い出す
    ・ そのデータを取ってくる際に検索する条件を設定
    ・ 取得件数を設定する

  5. Jsonに詰め替える

  6. Jsonデータを返却する

その後、実際に実装して行く流れになります。

プログラミングにおいて大切なこと

APIを実装していて、プログラミングをする上で大切なことを学びました。
・日本語でコードをしっかり読めること
・感覚でやらないこと
・問題点を絞っていく力を身につけること
コードを日本語で読むことができたら書ける。その通りだなと思いました。感覚でふんわりとしかコードが読めていないと曖昧なコードになってしまって、結果エラーやバグの元になってしまう。一単語の一単語の意味を理解することが思っている以上に難しい。。。流すことなく1行のコードと向き合っていくことを意識する!今後も私の課題です! 以上、土屋でした!