git.iko.soy/urbit.org
on cb112e8 help sign in
urbit.org/content/grants/urbit-http-interface-java-edition.md
63 lines 2.1 kB history raw
1+++
2title = "Urbit HTTP Interface — Java Edition"
3date = 2020-10-20
4[taxonomies]
5grant_type = ["Proposal"]
6grant_category = ["Core Dev"]
7[extra]
8image = ""
9description = "This proposal seeks to implement an HTTP interface to an Urbit instance in Java, and also seeks to build various related tooling."
10reward = 3
11assignee = "~sipfyn-pidmex"
12id = "288224550"
13completed = false
14link = ""
15+++
17# Urbit Interface — Java Edition
19This proposal seeks to create an API to interact with an Urbit ship over HTTP written in Java.
21One benefit of a Java implementation would be that any JVM languages (Clojure, Kotlin, etc.) that support the use of Java libraries can also make use of it.
23## Outline
25This comprises three parts:
271. **Basic HTTP Interface** - Responsible for sending and receiving JSON to/from an Urbit ship
292. **Graph Store Interface** - Interface to the `graph-store` Urbit API on top of the HTTP Interface
313. **Additional Agent Interfaces** - Interface to the `group-store` and `metadata-store` Gall agents
33In addition, we will seek to document the code throughout the evolution of the proposal, providing READMEs along the way.
35## Plan
371. Study existing implementations and documentation
382. Create smallest initial working product for each milestone
393. Test it out with more experienced Urbit developers
404. Finalize and write documentation
42Qualifications:
44I'm qualified to implement this because I am experienced with Java. I have used Java for 3+ years, written robotics code using Java, and have experience using the Gradle build system.
46My github profile is at https://github.com/ynx0, where I have written software projects in other languages, such as a parser/interpreter combo for a fantasy assembly language.
48## Milestones
50### Basic HTTP Interface
521 stars
53Implementation of the HTTP Interface responsible for sending and receiving JSON to/from an Urbit ship
55### Graph Store Interface
571 stars
58Implementation of the interface to `graph-store`, which sits on top of the HTTP Interface
60### Additional Agent Interfaces
621 stars
63Implementation of the `group-store` and `metadata-store` Gall agents