ipsumapi

0.1.2 • Public • Published

WARNING! : Work in progress not usable yet!

ipsumapi

A Lorem Ipsum place-holder text REST API service with steroids.

With ipsumapi you can fetch Lorem Ipsum like place-holder texts in different formats and sizes.

Allows to get more than just simple text, see what it can do:

  • It has support for words.
  • It has support for sentences.
  • It has support for paragraphs.

API Documentation

On the first point, you must know that ipsumapi implements a common URL scheme for all of this resources. It follows REST guidelines and supports semantic URLs.

An URL for a resource will have this format:

http://ipsumapi.herokuapp.com/api/<resource>.<format>?<parameters>

Supported Result Formats

Currently supports the following formats:

  • JSON ( JavaScript Object Notation )
  • XML ( eXtensible Markup Language )

Available Resources

This are the current available resources:

Resource : Words

This resource returns single words:

Resource URL: http://<server>/api/words.json

Parameters:

params list

Resource : Sentences

This resource returns sentences usually ended with a dot punctuation sign.

Resource URL: http://<server>/api/sentences.json

Parameters:

params list

Resource : Paragraphs

This resource returns multi-line series of sentences, commonly known as paragraphs.

Resource URL: http://<server>/api/paragraphs.json

Parameters:

params list

Readme

Keywords

Package Sidebar

Install

npm i ipsumapi

Weekly Downloads

1

Version

0.1.2

License

none

Last publish

Collaborators

  • repejota