Skip to content

Latest commit

 

History

History
131 lines (79 loc) · 2.93 KB

README.md

File metadata and controls

131 lines (79 loc) · 2.93 KB
Raw

SpaceAPI Parser for Kotlin/Java

This is a parser library written in Kotlin that can be used from Kotlin and Java.

The parser is quite lenient, so it will ignore unknown fields, should be able to deal with multiple versions and will sometimes even parse invalid endpoint JSON. Additionally, in most cases, values with a fixed set of allowed values is parsed as String, not as enum. (If you need strict validation, use a JSON schema based validator instead!)

API Version Support

This library supports parsing any valid JSON file using the following schema version:

  • v0.13
  • v14

Note: Endpoints using versions 0.12 and older are not supported, they will result in a ParseError being thrown.

Installing

Gradle

First, ensure that the Maven Central repository is added to the gradle config:

repositories {
    mavenCentral()
}

Then, add the dependency to your build.gradle:

implementation 'io.github.spaceapi-community:spaceapi-kt:0.6.1'

Usage

Kotlin

import io.spaceapi.parseString

// ...

val parsed = parseString("{...}")

Java

import io.spaceapi.SpaceApiParser;
import io.spaceapi.types.Status;

// ...

final Status parsedStatus = SpaceApiParser.parseString("{...}");

Building

To build a JAR file, run:

./gradlew build

The resulting JAR files can be found in the build/libs/ directory.

Testing

Unit Tests

Run the following command to run the unit tests:

./gradlew test

Directory Parser

In the src/test/kotlin/io/spaceapi/ directory there's a DirectoryParser.kt program that can be executed. It fetches all directory endpoints and tests whether the endpoint can be deserialized. If not, an error message is printed.

Manual testing

Create a local publication (usually at $HOME/.m2/repository/):

./gradlew publishToMavenLocal

Include it in your project like this:

repositories {
    ...
    mavenLocal()
}

Signing

Releases are signed with the following PGP public key:

pub   ed25519 2022-11-19 [C]
      20EE002D778AE197EF7D0D2CB993FF98A90C9AB1
sub   ed25519/0x73574DD095640FCF 2022-11-19 [S] [expires: 2025-11-18]

License

This project is licensed under the GNU General Public License v3.0 or later.

spaceapi-kt
Copyright (C) 2020-2024 Danilo Bargen

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.