CHANSHIGELOG

いろんなこと

whoisproxyのAPI仕様変更しました

ちゃんしげです。ちょくちょくご利用いただいている api.whoisproxy.infoですが、以下を変更しました。

  • URIに含まれていた"APIバージョニング"の廃止 '/v1'
  • 404 NotFound時に、リクエスト可能なAPI形式をlinkで提供

APIバージョニングについては様々な意見があって、よく議論されている部分かなと思いますが、そもそも不要なのでは?というところから、本APIの利用者様に提供するレスポンスの内容(価値)に大きな変更が無いので、もっと気軽にリクエストできるように廃止しました。

例として、https://api.whoisproxy.info にリクエストした場合は、特別なリソースを設定していないので404ですが、'_link'プロパティにリクエスト可能な形式を記載しています。

Content-Type: application/problem+json;charset=utf-8

{
  "code": 404,
  "state": "fail",
  "_links": {
    "self": {
      "href": "/"
    },
    "doc:whois": {
      "href": "/whois/{domain}",
      "title": "Lookup find out the registered domain holder."
    },
    "doc:dig": {
      "href": "/dig/{domain}[/{q-type}]",
      "title": "domain information groper."
    },
    "reference": {
      "href": ""
    }
  },
  "results": "Welcome to a whoisproxy api."
}

※上記 /whois/dig でのレスポンス形式はこれまで通りです。

このような感じで、APIへのリクエスト方法を使い手側が知らなくても、とりあえず投げてみればわかるほうが便利じゃんと思いました。

奥が深いRESTの世界に興味があるので、引き続き学びつつアップデートしていきます。是非ご意見お待ちしております!!!!1