Skip to content
Branch: master
Go to file
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

morphgnt-api

an experimental REST API for MorphGNT

This is available on http://api.morphgnt.org/.

Note that the /v0/ prefix is used because there is no commitment to keep this API. It is subject to rapid change at the moment.

The URI patterns are:

/v0/root.json
/v0/book/{osis_id}.json
/v0/paragraph/{paragraph_id}.json
/v0/sentence/{sentence_id}.json
/v0/verse/{verse_id}.json
/v0/word/{word_id}.json
/v0/verse-lookup/?{verse-reference}
/v0/frequency/

A word (currently) looks something like this:

{
    "@id": "/v0/word/64001001005.json",
    "@type": "word",
    "verse_id": "/v0/verse/640101.json",
    "sentence_id": "/v0/sentence/640001.json",
    "paragraph_id": "/v0/paragraph/64001.json",
    "crit_text": "λόγος,",
    "text": "λόγος,",
    "word": "λόγος",
    "norm": "λόγος",
    "lemma": "λόγος",
    "pos": "N",
    "case": "N",
    "number": "S",
    "gender": "M",
    "dep_type": "S",
    "head": "/v0/word/64001001002.json"
}

A verse (currently) looks something like this:

{
    "@id": "/v0/verse/640101.json",
    "@type": "verse",
    "title": "John 1.1",
    "prev": null,
    "next": "/v0/verse/640102.json",
    "book": "/v0/book/John.json",
    "words": [...]
}

where words is a list of objects like the word above.

A paragraph and sentence are very similar to a verse (with an @id, @type, prev, next, book and words list).

A book (currently) looks something like this:

{
    "@id": "/v0/book/1Cor.json",
    "@type": "book",
    "name": "1 Corinthians",
    root: "/v0/root.js",
    "first_paragraph": "/v0/paragraph/67001.json",
    "first_verse": "/v0/verse/670101.json",
    "first_sentence": "/v0/sentence/670001.json"
}

/v0/verse-lookup/?{verse-reference} parses the verse reference and returns a JSON object indicating the URL of the verse resource.

e.g. /v0/verse-lookup/?Jn+3.16 will return {"verse_id": "/v0/verse/640316.json"}

A variety of book name abbreviations are supported.

/v0/frequency/ takes a body of a JSON object containing an input property whose value consists of a list of JSON objects each with an id and lemma property. The response is a JSON object with an output property whose value consists of a list of JSON objects each with an id and count property. The count property gives the lemma count of the input lemma. The output counts are correlated to the input lemmas via matching id values.

Feedback is greatly appreciated to make this whole API more useful.

About

an experimental REST API for MorphGNT

Resources

License

Releases

No releases published

Languages

You can’t perform that action at this time.