Skip to content

codeforsetagaya/api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 

Repository files navigation

世田谷API (非公式)

世田谷区のオープンデータについて、公開しているもののCSVやJSONなど再利用可能な形式になっていないものについて、代替APIを提供するためのリポジトリです。

現在提供しているAPI

コミットするには

  • 必要なAPIについて提案する → Issue
  • 情報ソースを探して報告する → Issue
  • APIを作る → コミット歓迎です

APIの作り方

静的な提供 (あるいは手作り)

既存のデータをコンバートして、コミットしてください。

動的な提供

コンバート済みのデータとともに、コンバータやスクレーピングのためのスクリプトを一緒にコミットしてください。

※現在のところ、GitHubでホスティングしているので、リアルタイムで変化するものについては対応できません。こちらについて、必要なケースが出て来た場合は、Issueで議論しましょう。

ディレクトリ構成

API名でディレクトリを作成します。その下の使い方については、まだ特にルールを設けていませんが、極力シンプルになるよう努めて下さい。また、README.mdをディレクトリ毎に用意して、下記を明記してください。

  • データの出典
  • 元のライセンス
  • データの更新方法 (手動 or 自動、必要なソフトウェア、コマンドの使い方など)
  • 作成者・提案者
  • APIの使い方

データのライセンス

APIを作成する際、データの出典を明記します。また、区以外が提供元の場合はライセンスに注意してください。

  • パブリックなデータ、オープンデータ
  • Creative Commons、オープンソースライセンス
  • ライセンス保持者からの許可を得ている

上記のいずれかの場合のみ、コミットを受け付けます。

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published