Skip to content
Oxi wraps an asynchronous Rust server around Mercury Parser.
Rust
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
Cargo.lock
Cargo.toml
LICENSE
README.md

README.md

Oxi

Oxi wraps an asynchronous, performant server around Mercury Parser, providing a simple API to POST to.

Quick Start

  1. Download the latest release
  2. Install mercury-parser
  3. $ oxi
  4. $ http POST http://127.0.0.1:8080/parse url=https://elliotekj.com/2019/12/20/sqlite-ios-advanced-grdb

Dependencies

mercury-parser must be in your $PATH.

$ npm -g install @postlight/mercury-parser

Usage

Oxi only has one endpoint: /parse. It expects an application/json Content-Type and accepts the parameters below. If Mercury Parser fails to parse the given URL, Oxi will return status code 422.

Key Value Type Description
url String The url you want to parse.
format Optional<String> The output format of the article's content. Options: html (default), markdown, text.

To start Oxi, add it to your $PATH and run oxi. By default it will run on port 8080, but you can use the -p flag to customise that. Example:

$ oxi -p 8181

License

Oxi is released under the MIT LICENSE.

About

Oxi was written by Elliot Jackson.

You can’t perform that action at this time.