差分

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

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