差分

このページの2つのバージョン間の差分を表示します。

--- software:national-holiday-api [2013/06/10 14:54] – dot
+++ software:national-holiday-api [2015/06/17 05:21] (現在) – 外部編集 127.0.0.1
@@ 行 3: / 行 3: @@
 国民の祝日の管理機能と Web API を提供します。
+[[https://github.com/shinoburc/national-holiday-api|github national-holiday-api]]
 ====== 機能要件 ======
@@ 行 13: / 行 14: @@
 ====== インストール ======
+github からソース取得
+  git clone git://github.com/shinoburc/national-holiday-api.git
-  * からソース取得
+gemのインストール
+  cd national-holiday-api
+  bundle install
+DBセットアップ
+  rake db:setup
+rails 起動
+  rails s
+ブラウザでアクセス
+  http://localhost:3000
+デフォルトのユーザ名とパスワードは「admin@local.host/caladmin」です。
+seed.rb には1948年から2150年までの祝日が設定されています。
+====== herokuにデプロイ ======
+github からソース取得
   git clone git://github.com/shinoburc/national-holiday-api.git
-  * gemのインストール
+heroku にアプリケーションを作成
-    * cd national-holiday-api
+  cd national-holiday-api
-    * bundle install
+  heroku create YOUR_APP_NAME
+  git push heroku master
+DBセットアップ
+  heroku run rake db:setup
-  * DBセットアップ
+ブラウザでアクセス
-    * rake db:setup
+  http://YOUR_APP_NAME.heroku.com
-  * rails 起動
+デフォルトのユーザ名とパスワードは「admin@local.host/caladmin」です。
-    * rails s
+まず最初にパスワードを変更してください。
+パスワード変更は「Administration」から行えます。
-  * ブラウザでアクセス
+====== APIs ======
-    * http://localhost:3000
-default username and password is admin@local.host/caladmin. and default seed.rb data is Japanese national holidays.
+===== DATE1からDATE2までの祝日一覧を取得する =====
-APIs
+  api/holidays/list/DATE1/DATE2
-api/holidays/list/DATE1/DATE2 : Get holidays list between DATE1 and DATE2
+例)
+  localhost:3000/api/holidays/list/2013-01-01/2013-12-31
+  (永続 API URL : localhost:3000/api/v1/holidays/list/)
+  (今後、永続 API URL は戻り値等が変更されません)
-e.g.) localhost:3000/api/holidays/list/2013-01-01/2013-12-31
+上記では2013年の祝日一覧がJSON形式で取得されます。
-(permanent API url is localhost:3000/api/v1/holidays/list/)
+XML形式で取得することもできます。
-return value is holidays list in 2013 as JSON.
+例)
+  localhost:3000/api/holidays/list/2013-01-01/2013-12-31.xml
-You can get list as XML following.
+そして、[[http://unicorn.us.com/cal.html|.cal.dat]]形式で取得することもできてしまいます。
+(これがやりたかったのでございます。)
-e.g.) localhost:3000/api/holidays/list/2013-01-01/2013-12-31.xml
+例)
+  localhost:3000/api/holidays/list/2013-01-01/2013-12-31.caldat
-And! you can get list as .cal.dat format following. Yes!!
+===== DATE1 が祝日か調べる =====
+  api/holidays/is_holiday/DATE1
-e.g.) localhost:3000/api/holidays/list/2013-01-01/2013-12-31.caldat
+例)
+  localhost:3000/api/holidays/is_holiday/2013-01-01
+  (永続 API URL : localhost:3000/api/v1/holidays/is_holiday/)
-api/holidays/is_holiday/DATE1 : Check DATE1 is holiday?
+true か false が帰ります。
-e.g.) localhost:3000/api/holidays/is_holiday/2013-01-01
+====== APIs demo ======
-(permanent API url is localhost:3000/api/v1/holidays/is_holiday/)
+[[http://national-holiday-api.heroku.com/api/holidays/list/2013-01-01/2013-12-31]]
-return true or false.
+[[http://national-holiday-api.heroku.com/api/holidays/is_holiday/2013-01-01]]
-APIs demo
+====== トップページ demo ======
-dandydot.dyndns.org:3001/api/holidays/list/2013-01-01/2013-12-31
-dandydot.dyndns.org:3001/api/holidays/is_holiday/2013-01-01
+[[http://national-holiday-api.heroku.com]]