Skip to content
This repository has been archived by the owner on Apr 21, 2018. It is now read-only.

Given a CSV file (or a series of YAML files), generates a RESTful API using Jekyll

Notifications You must be signed in to change notification settings

benbalter/jekyll-restful-api-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jekyll RESTful API Generator

Given a CSV file (or a series of YAML files), generates a RESTful API. Sorta. Uses XML and JSON Jekyll templates to generate machine-readable files from the YAML headers of any file in the directory project. Any key value pair will be converted.

Usage for CSV files

  1. Place CSV file in /raw/
  2. Edit _config.yml as appropriate
  3. Run /php/config.php
  4. Push to GitHub or run Jekyll locally

Usage for YAML files

  1. Place YML files in either the root directory, or any number of sub directories.
  2. Place key/value pairs in the YML header
  3. Push to GitHub or run Jekyll locally

Status

This project constitutes a functional proof-of-concept. The script that converts CSV files to YAML files is written in PHP, which is probably not the best choice in the long run.

Todo

  • Generate XML and JSON indexes of all records
  • Multi-dimensional arrays within YAML headers

Example Data

License

GPLv3 or Later

About

Given a CSV file (or a series of YAML files), generates a RESTful API using Jekyll

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Languages