概要

例) 蛍柄の螢光灯

きっかけ

業務上で旧漢字と新漢字を変換するプログラム開発があり、
API経由でコンバートしてくれる仕組みがあれば便利だと思い開発に至った。
※その時は一から実装しましたが、自分と同じ考えの人も少なからずいると思ったので…

またAPIを作成しても周知しなければ使用してもらえないと思い、初めてQiitaに投稿することにした。

GET http://api.lesson-pg.com/v1/kanji/

パラメータ	型	例	備考
article	String	/v1/kanji/?article=螢が飛んでいる	旧漢字/新漢字を含む文章を渡す (※500 文字まで)

Response 200 (application/json)

{
  "old": "螢が飛んでいる",
  "new": "蛍が飛んでいる",
  "includedOld": true,
  "includedNew": false,
  "count": 1
}

プロパティ	型	例	備考
old	String	螢が飛んでいる	新漢字を旧漢字へ変換した値
new	String	蛍が飛んでいる	旧漢字を新漢字へ変換した値
includedOld	Bool	true	旧漢字が含まれるか
includedNew	Bool	true	旧漢字が含まれるか
count	Integer	1	存在した旧漢字数

Response 400 (application/json)

{
  "message": "The maximum number of characters (500 characters) has been exceeded"
}

Response 404 (application/json)

{
  "message": "Not Found"
}

Response 405 (application/json)

{
  "message": "Method Not Allowed"
}

API開発では今まで「Postman」を使用していたが、今回はVSCode拡張機能「Thunder Client」を使用 ※VSCodeで完結できるため採用

パラメータを入力後「Send」ボタンをクリック

※値が返ってきていることを確認できた

細かい仕様やソースコードはこちらにあります↓
https://github.com/uswebk/KanjiConvertAPI

アドバイスや改善点があればお申し付けください。