読者です 読者をやめる 読者になる 読者になる

なか日記

一度きりの人生、楽しく生きよう。

雑な短縮URLサービスに登録用のWebAPIを追加しました

ASP.NET

この前公開した雑な短縮URLサービスに短縮URLを登録するWebAPIを追加しました。

使い方は以下の通りです。

短縮URLの登録

POST http://nkd.jp/api/ShortUrls

Request

url: 短縮したいURL

Sample

{
  "url": "http://nakaji.hatenablog.com/"
}

Response

Id: 通番
Original: 元のURL
Short: 短縮URL
Hash: URLの識別子
User: 常にnull
Counter: 参照された回数

Sample

{
  "Id":19,
  "Original":"http://nakaji.hatenablog.com/",
  "Short":"http://nkd.jp/129f5f",
  "Hash":"129f5f",
  "User":null,
  "Counter":0
}

ちなみに

同URLをGETすると登録されてる全URLの一覧が取ってこれたりします。

勉強不足

WebAPIのパラメータにstringの変数を指定してたら思ったようにバインディングしてもらえなかった件 - なか日記に書きましたが、本質を理解できてなくて余計な時間を取られました。一度通れば次は問題ない所だとは思いますが。

一応、下記サイトをさらっと目を通して最低限の知識は得ましたが、それでも設計や実装面でも悩むことが多いです。

悩ましい所

  • 設計面
    • どういう名前(URL)にするのがいい
  • 実装面
    • エラー時のレスポンスはHttpResponseMessageを返すのがいいのか、それともHttpResponseExceptionを投げるのがいいのか

実践あるのみだとは思いますが、自分が手を動かしていろいろ疑問を持った上で他の人が書いたコードを見るのが良いのかもしれないですね。