Skip to content

Latest commit

 

History

History
38 lines (30 loc) · 1.42 KB

README.md

File metadata and controls

38 lines (30 loc) · 1.42 KB

LUSID® Java SDK

Maven artifacts can be downloaded from the Open Source Software Repository Hosting (OSSRH) by adding the following to your pom.xml

<project>
  ...
  <repositories>
    <repository>
      <id>osssrh</id>
      <name>OSSRH</name>
      <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
    </repository>
  </repositories>

  <dependencies>
    <dependency>
      <groupId>com.finbourne</groupId>
      <artifactId>lusid-sdk</artifactId>
      <version>{INSERT VERSION}</version>
    </dependency>
    ...
  </dependencies>
  ...
</project>

A pre-generated version of the latest SDK is included in the sdk folder based on the OpenAPI specification named lusid.json in the root folder. The most up to date version of the OpenAPI specification can be downloaded from https://api.lusid.com/swagger/v0/swagger.json

In addition to the SDK, a set of examples on how to use the SDK can be found in the sdk/src/test/java folder. These exist in the form of unit tests. Further instructions on running them can be found in the README.

Generating the SDK

If you would prefer to generate the Java SDK locally from the FINBOURNE OpenAPI specification, this can be done using docker and docker-compose:

$ docker-compose up && docker-compose rm -f