Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/docpad-archive/docpad-plugin-restapi

Exposes a REST API for performing CRUD actions within DocPad
https://github.com/docpad-archive/docpad-plugin-restapi

docpad-plugin unsupported

Last synced: 2 days ago
JSON representation

Exposes a REST API for performing CRUD actions within DocPad

Host: GitHub
URL: https://github.com/docpad-archive/docpad-plugin-restapi
Owner: docpad-archive
License: other
Created: 2013-08-11T22:57:12.000Z (about 11 years ago)
Default Branch: master
Last Pushed: 2023-12-11T09:51:57.000Z (11 months ago)
Last Synced: 2024-10-23T00:25:26.746Z (16 days ago)
Topics: docpad-plugin, unsupported
Language: CoffeeScript
Homepage:
Size: 60.5 KB
Stars: 5
Watchers: 18
Forks: 3
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # CRUD REST API Plugin for [DocPad](http://docpad.org)

[![Build Status](https://img.shields.io/travis/docpad/docpad-plugin-restapi/master.svg)](http://travis-ci.org/docpad/docpad-plugin-restapi "Check this project's build status on TravisCI")

[![NPM version](https://img.shields.io/npm/v/docpad-plugin-restapi.svg)](https://npmjs.org/package/docpad-plugin-restapi "View this project on NPM")

[![NPM downloads](https://img.shields.io/npm/dm/docpad-plugin-restapi.svg)](https://npmjs.org/package/docpad-plugin-restapi "View this project on NPM")

[![Dependency Status](https://img.shields.io/david/docpad/docpad-plugin-restapi.svg)](https://david-dm.org/docpad/docpad-plugin-restapi)

[![Dev Dependency Status](https://img.shields.io/david/dev/docpad/docpad-plugin-restapi.svg)](https://david-dm.org/docpad/docpad-plugin-restapi#info=devDependencies)


[![Gratipay donate button](https://img.shields.io/gratipay/docpad.svg)](https://www.gratipay.com/docpad/ "Donate weekly to this project using Gratipay")

[![Flattr donate button](https://img.shields.io/badge/flattr-donate-yellow.svg)](http://flattr.com/thing/344188/balupton-on-Flattr "Donate monthly to this project using Flattr")

[![PayPayl donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QB8GQPZAH84N6 "Donate once-off to this project using Paypal")

[![BitCoin donate button](https://img.shields.io/badge/bitcoin-donate-yellow.svg)](https://coinbase.com/checkouts/9ef59f5479eec1d97d63382c9ebcb93a "Donate once-off to this project using BitCoin")

[![Wishlist browse button](https://img.shields.io/badge/wishlist-donate-yellow.svg)](http://amzn.com/w/2F8TXKSNAFG4V "Buy an item on our wishlist for us")

Add a REST API to your DocPad project for interacting with DocPad files and documents

[REST API Specification can be found on the Web Write Project's Specification Page](https://github.com/webwrite/spec#rest)

## Install

```

docpad install restapi

```

## Usage

Once installed, the `/restapi/` URL on your website will conform to the [WebWrite Specification](https://github.com/webwrite/spec#rest)

## History

[Discover the change history by heading on over to the `HISTORY.md` file.](https://github.com/docpad/docpad-plugin-restapi/blob/master/HISTORY.md#files)

## Contribute

[Discover how you can contribute by heading on over to the `CONTRIBUTING.md` file.](https://github.com/docpad/docpad-plugin-restapi/blob/master/CONTRIBUTING.md#files)

## Backers

### Maintainers

These amazing people are maintaining this project:

- Neil Taylor  (https://github.com/neilbaylorrulez)

- Benjamin Lupton  (https://github.com/balupton)


### Sponsors

These amazing people have contributed finances to this project:

- Myplanet Digital  (http://www.myplanetdigital.com)

Become a sponsor!

[![Gratipay donate button](https://img.shields.io/gratipay/docpad.svg)](https://www.gratipay.com/docpad/ "Donate weekly to this project using Gratipay")

[![Flattr donate button](https://img.shields.io/badge/flattr-donate-yellow.svg)](http://flattr.com/thing/344188/balupton-on-Flattr "Donate monthly to this project using Flattr")

[![PayPayl donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QB8GQPZAH84N6 "Donate once-off to this project using Paypal")

[![BitCoin donate button](https://img.shields.io/badge/bitcoin-donate-yellow.svg)](https://coinbase.com/checkouts/9ef59f5479eec1d97d63382c9ebcb93a "Donate once-off to this project using BitCoin")

[![Wishlist browse button](https://img.shields.io/badge/wishlist-donate-yellow.svg)](http://amzn.com/w/2F8TXKSNAFG4V "Buy an item on our wishlist for us")

### Contributors

These amazing people have contributed code to this project:

- [Benjamin Lupton](https://github.com/balupton)  — [view contributions](https://github.com/docpad/docpad-plugin-restapi/commits?author=balupton)

- [Neil Taylor](https://github.com/neilbaylorrulez)  — [view contributions](https://github.com/docpad/docpad-plugin-restapi/commits?author=neilbaylorrulez)


[Become a contributor!](https://github.com/docpad/docpad-plugin-restapi/blob/master/CONTRIBUTING.md#files)

## License

Unless stated otherwise all works are:

- Copyright © 2013+ Bevry Pty Ltd  (http://bevry.me)

and licensed under:

- The incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://opensource.org/licenses/mit-license.php)