無料でPHP使ってWebAPIをつくってみた

Posted at 2020-02-15

はじめに

以前つくった文字列→塩基配列の相互変換ツールをつくってみた(アプリ版)のWeb版（PHP）がこれにより不要になってしまいました

せっかく作ったPHP版も何かに使えないかと思いAPI化してみました

＊注意 httpです

成果物

ドキュメント

BluePrintでAPIドキュメントみたいなのつくってみましたので詳細はこれを見てください

http://adventam10.php.xdomain.jp/dna/api/

ソース

下記の dna-converter.php です。

https://github.com/adventam10/DNAConverter-web/tree/master/api

API化

PHPで簡単なWebAPIを実装してみるを参考に実装！！

こんな感じで実装して下記のように XFREE にアップ！！！

無料でできるPHPのWEBサイト公開（テスト用）

<?php
header('Content-Type: text/html; charset=UTF-8');

$json_string = file_get_contents('php://input');
$json = json_decode($json_string, true);
$resultCode = checkResultCode($json);
if($resultCode === 0) {
    $arr["resultCode"] = $resultCode;
    $arr["convertedText"] = convert($json["text"], $json["mode"]);
} else {
    $arr["resultCode"] = $resultCode;
}

print json_encode($arr, JSON_PRETTY_PRINT);

swift で確認してみる

let urlString = "http://adventam10.php.xdomain.jp/dna/api/dna-converter.php"
var request = URLRequest(url: URL(string: urlString)!)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpMethod = "POST"
request.httpBody = try? JSONEncoder().encode(Request(mode: 0, text: "あいうえお"))
let task = URLSession.shared.dataTask(with: request) { (data, _, error) in
  let response = try? JSONDecoder().decode(Response.self, from: data!)
  print(response)
}
task.resume()

struct Request: Codable {
    let mode: Int
    let text: String
}

struct Response: Codable {
    let resultCode: Int
    let convertedText: String
}

ちゃんと以下のように取得できていました

Optional(Test.Response(resultCode: 0, convertedText: "GCAGCAATCAACGCAGCAATCATAGCAGCAATCATCGCAGCAATCACAGCAGCAATCACC"))

ハマったとこ

POSTMAN を使って確認していたのですが下記のようにリクエストをしていると mode が数値ではなく文字列になってしまいハマりました。

その時のPHPの実装が下記

$resultCode = checkResultCode($_POST);
function checkResultCode($param) {
  if (isset($param["mode"])) {
    $mode = $param["mode"];
    if ($mode === 0 || $mode === 1) { // 文字列なのでここでアウト
      if (!empty($param['text'])) {
        $text = $param['text'];
        if ($mode === 0) {
          return 0;
        } else {
          if (isInvalidDNA($text)) {
            return 4;
          } else {
            return 0;
          }
        }
      } else {
        return 3;
      }
    } else {
      return 2;
    }
  } else {
    return 1;
  }
}

POSTMAN で下記のように JSON を設定すると数値が送れるらしいと聞いたので修正。

が、しかし、PHP が $_POST だったので値を受け取れず

どうやら $_POST では JSON を受け取れない模様。

参考：JSON形式でPOSTされたデータの受信方法

下記のように PHP を修正。

$json_string = file_get_contents('php://input');
$json = json_decode($json_string, true); // 第2引数にtrueを設定しないとダメらしい
$resultCode = checkResultCode($json);
function checkResultCode($param) {
  if (isset($param["mode"])) {
    $mode = $param["mode"];
    if ($mode === 0 || $mode === 1) {
      if (!empty($param['text'])) {
        $text = $param['text'];
        if ($mode === 0) {
          return 0;
        } else {
          if (isInvalidDNA($text)) {
            return 4;
          } else {
            return 0;
          }
        }
      } else {
        return 3;
      }
    } else {
      return 2;
    }
  } else {
    return 1;
  }
}