fixed index documentation
This commit is contained in:
+7
-15
@@ -20,28 +20,20 @@ html{
|
||||
<li><a href="https://api.1611.social/votd">/votd</a> - A random verse that changes from day-to-day.</li>
|
||||
<li><a href="https://api.1611.social/search">/search</a> - Search keywords</li>
|
||||
<li><a href="https://api.1611.social/show?kw=John3:16">/show</a> - Show a set of verses</li>
|
||||
<li><a href="https://api.1611.social/define">/define</a> - Show a set of verses</li>
|
||||
<li><a href="https://api.1611.social/define">/define</a> - Search the Dictionary</li>
|
||||
</ul>
|
||||
|
||||
<h3>Verse searching</h3>
|
||||
<p>'/show?kw=' will try to match single verses and verse ranges. For example:</p>
|
||||
<p>'/show?kw=' will try to match single verses and verse ranges. (not sets) For example:</p>
|
||||
<pre>
|
||||
<code>
|
||||
/search?kw=john3:16
|
||||
/search?kw=John 3:13-18
|
||||
/search?kw=2 Peter 2:8
|
||||
/search?kw=1 John 3:3- (gets the whole rest of the chapter)
|
||||
/search?kw=ecc 2:1-
|
||||
/show?kw=john3:16
|
||||
/show?kw=1 John 3:3- (gets the whole rest of the chapter)
|
||||
</code>
|
||||
</pre>
|
||||
|
||||
<h3>Keyword searching</h3>
|
||||
<p>'/search?kw=keyword' accepts a search word, and will return any verses matching the query. For example:</p>
|
||||
<pre>
|
||||
<code>
|
||||
|
||||
</code>
|
||||
</pre>
|
||||
|
||||
<h3>Integration</h3>
|
||||
<p>If you want to put the verse of the day into your website, you can use the following example php:</p>
|
||||
@@ -54,8 +46,9 @@ API ENDPOINT SPECIFICATION v 0.2
|
||||
|
||||
/random - outputs a random verse
|
||||
/votd - returns verse of the day
|
||||
/search - returns a keyword search result set
|
||||
/search - returns a keyword search result set (no args is a landing page)
|
||||
/show - returns a verse or set of verses by name/location
|
||||
/define - 1828 Noah Webster dictionary (no args is a landing page)
|
||||
|
||||
URL PARAMETERS
|
||||
==============
|
||||
@@ -67,8 +60,7 @@ default: json
|
||||
|
||||
?kw=
|
||||
- comma-delimited keyword search for /search
|
||||
search default: faith
|
||||
show default: john3:16
|
||||
|
||||
|
||||
EXAMPLES
|
||||
========
|
||||
|
||||
Reference in New Issue
Block a user