diff --git a/.gitignore b/.gitignore index 12308c2..105d892 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ /_site .DS_Store +Gemfile.lock diff --git a/Gemfile.lock b/Gemfile.lock deleted file mode 100644 index cbcdf85..0000000 --- a/Gemfile.lock +++ /dev/null @@ -1,96 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - RedCloth (4.2.9) - activesupport (4.1.1) - i18n (~> 0.6, >= 0.6.9) - json (~> 1.7, >= 1.7.7) - minitest (~> 5.1) - thread_safe (~> 0.1) - tzinfo (~> 1.1) - blankslate (2.1.2.4) - classifier (1.3.4) - fast-stemmer (>= 1.0.0) - colorator (0.1) - commander (4.1.6) - highline (~> 1.6.11) - fast-stemmer (1.0.2) - ffi (1.9.3) - gemoji (1.5.0) - github-pages (19) - RedCloth (= 4.2.9) - jekyll (= 1.5.1) - jekyll-mentions (= 0.0.6) - jekyll-redirect-from (= 0.3.1) - jekyll-sitemap (= 0.3.0) - jemoji (= 0.1.0) - kramdown (= 1.3.1) - liquid (= 2.5.5) - maruku (= 0.7.0) - rdiscount (= 2.1.7) - redcarpet (= 2.3.0) - highline (1.6.21) - html-pipeline (1.5.0) - activesupport (>= 2) - nokogiri (~> 1.4) - i18n (0.6.9) - jekyll (1.5.1) - classifier (~> 1.3) - colorator (~> 0.1) - commander (~> 4.1.3) - liquid (~> 2.5.5) - listen (~> 1.3) - maruku (= 0.7.0) - pygments.rb (~> 0.5.0) - redcarpet (~> 2.3.0) - safe_yaml (~> 1.0) - toml (~> 0.1.0) - jekyll-mentions (0.0.6) - html-pipeline (~> 1.5.0) - jekyll (~> 1.4) - jekyll-redirect-from (0.3.1) - jekyll (~> 1.4) - jekyll-sitemap (0.3.0) - jekyll (~> 1.4) - jemoji (0.1.0) - gemoji (~> 1.5.0) - html-pipeline (~> 1.5.0) - jekyll (~> 1.4) - json (1.8.1) - kramdown (1.3.1) - liquid (2.5.5) - listen (1.3.1) - rb-fsevent (>= 0.9.3) - rb-inotify (>= 0.9) - rb-kqueue (>= 0.2) - maruku (0.7.0) - mini_portile (0.6.0) - minitest (5.3.4) - nokogiri (1.6.2.1) - mini_portile (= 0.6.0) - parslet (1.5.0) - blankslate (~> 2.0) - posix-spawn (0.3.8) - pygments.rb (0.5.4) - posix-spawn (~> 0.3.6) - yajl-ruby (~> 1.1.0) - rb-fsevent (0.9.4) - rb-inotify (0.9.4) - ffi (>= 0.5.0) - rb-kqueue (0.2.2) - ffi (>= 0.5.0) - rdiscount (2.1.7) - redcarpet (2.3.0) - safe_yaml (1.0.3) - thread_safe (0.3.3) - toml (0.1.1) - parslet (~> 1.5.0) - tzinfo (1.1.0) - thread_safe (~> 0.1) - yajl-ruby (1.1.0) - -PLATFORMS - ruby - -DEPENDENCIES - github-pages diff --git a/_config.yml b/_config.yml index 65f4f19..dcbb6cc 100644 --- a/_config.yml +++ b/_config.yml @@ -1,10 +1,13 @@ # Base configuration -permalink: /news/:title +permalink: /news/:title exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "changelog.md"] -markdown: kramdown -pygments: true +markdown: redcarpet +highlighter: pygments gems: - jekyll-sitemap +redcarpet: + extensions: + - autolink #Prose.io editing info repo_name: API-All-the-X @@ -46,30 +49,28 @@ navigation: internal: true - text: Collaboration url: pages/collaboration - internal: true + internal: true - text: Tools url: pages/tools internal: true - text: Resources url: pages/resources - internal: true + internal: true - text: Education url: pages/education - internal: true + internal: true - text: Support url: pages/support internal: true - text: Status url: pages/status - internal: true + internal: true - text: About url: pages/about - internal: true + internal: true - text: Share your Feedback url: https://github.com/18F/API-All-the-X/issues internal: false - text: Contact Us url: pages/contact_us internal: true - - diff --git a/pages/api_recipes.md b/pages/api_recipes.md index 15d9865..59b6212 100644 --- a/pages/api_recipes.md +++ b/pages/api_recipes.md @@ -2,7 +2,6 @@ layout: page title: "API Recipes" authors: "Gray Brooks" - --- ## Background @@ -11,31 +10,43 @@ A place to share the technology stack and other recipe details behind assorted A ## General Options -**Python** -* Flask -* how-to's -* http://tech.pro/tutorial/1213/how-to-build-an-api-with-python-and-flask -* http://radar.oreilly.com/2014/05/building-restful-apis-with-flask-in-pycharm.html -addons -* Eve -* Flask-RESTful -* Flask-Restless -* Falcon - -**Java** +### General + +* http://www.restapitutorial.com/ +* http://orchestrate.io/blog/2014/08/05/turning-csvs-into-apis/ + +### Java + * https://docs.oracle.com/javaee/7/tutorial/doc/jaxrs.htm -Spark -* http://www.boxuk.com/blog/creating-rest-api-quickly-using-pure-java/ -* http://java.dzone.com/articles/building-simple-restful-api +* [Spark](http://sparkjava.com/) + * http://www.boxuk.com/blog/creating-rest-api-quickly-using-pure-java/ + * http://java.dzone.com/articles/building-simple-restful-api * http://docs.spring.io/spring/docs/3.0.0.M3/spring-framework-reference/html/ch18s02.html * http://www.vogella.com/tutorials/REST/article.html -**General** -* http://www.restapitutorial.com/ -* http://orchestrate.io/blog/2014/08/05/turning-csvs-into-apis/ +### Python + +* [Flask](http://flask.pocoo.org/) + * how-to's + * http://tech.pro/tutorial/1213/how-to-build-an-api-with-python-and-flask + * http://radar.oreilly.com/2014/05/building-restful-apis-with-flask-in-pycharm.html + * addons + * [Eve](http://python-eve.org/) + * [Flask-RESTful](http://flask-restful.readthedocs.org/en/latest/) + * [Flask-Restless](https://github.com/jfinkels/flask-restless/) +* [Falcon](http://falconframework.org/) +* [Django REST Framework](http://www.django-rest-framework.org/) +### Ruby -## Examples of Active APIs +* [Grape](http://intridea.github.io/grape/) +* [Sinatra](http://www.sinatrarb.com/) +* [Rails](http://rubyonrails.org/) / [Rails::API](https://github.com/rails-api/rails-api) + * http://www.theodinproject.com/ruby-on-rails/apis-and-building-your-own + * https://www.codeschool.com/courses/surviving-apis-with-rails + * https://www.airpair.com/ruby-on-rails/posts/building-a-restful-api-in-a-rails-application + +## Examples of Active APIs ### CFPB @@ -51,9 +62,8 @@ Source: https://github.com/GSA/DataBeam/ Built on: -* http://github.com/project-open-data/db-to-api +* http://github.com/project-open-data/db-to-api * http://github.com/philsturgeon/codeigniter-restserver -* http://github.com/philsturgeon/codeigniter-oauth2 -* http://github.com/blueimp/jQuery-File-Upload/ -* http://github.com/wordnik/swagger-ui - +* http://github.com/philsturgeon/codeigniter-oauth2 +* http://github.com/blueimp/jQuery-File-Upload/ +* http://github.com/wordnik/swagger-ui