git.iko.soy/urbit.org
on d7dad8b help sign in
urbit.org/content/grants/urbit-http-interface-java-edition.md
65 lines 2.1 kB history raw
1+++
2title = "Urbit HTTP Interface — Java Edition"
3date = "2020-10-19"
5[taxonomies]
6grant_type = [ "Proposal" ]
7grant_category = [ "Core Dev" ]
9[extra]
10image = ""
11description = "This proposal seeks to implement an HTTP interface to an Urbit instance in Java, and also seeks to build various related tooling."
12reward = 3
13assignee = "~sipfyn-pidmex"
14id = "288224550"
15completed = false
16link = ""
17+++
19# Urbit Interface — Java Edition
21This proposal seeks to create an API to interact with an Urbit ship over HTTP written in Java.
23One 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.
25## Outline
27This comprises three parts:
291. **Basic HTTP Interface** - Responsible for sending and receiving JSON to/from an Urbit ship
312. **Graph Store Interface** - Interface to the `graph-store` Urbit API on top of the HTTP Interface
333. **Additional Agent Interfaces** - Interface to the `group-store` and `metadata-store` Gall agents
35In addition, we will seek to document the code throughout the evolution of the proposal, providing READMEs along the way.
37## Plan
391. Study existing implementations and documentation
402. Create smallest initial working product for each milestone
413. Test it out with more experienced Urbit developers
424. Finalize and write documentation
44Qualifications:
46I'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.
48My 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.
50## Milestones
52### Basic HTTP Interface
541 stars
55Implementation of the HTTP Interface responsible for sending and receiving JSON to/from an Urbit ship
57### Graph Store Interface
591 stars
60Implementation of the interface to `graph-store`, which sits on top of the HTTP Interface
62### Additional Agent Interfaces
641 stars
65Implementation of the `group-store` and `metadata-store` Gall agents