Giter VIP home page Giter VIP logo

appd-api's Introduction

Application Directory API -- THIS IS NOT A RATIFIED FDC3 API or SPECIFICATION

This is NOT a ratified API or specification but rather a tool to evaluate both the use cases and technology implementations.

Overview

This project is a POC focused on creation of an Application Directory API as defined through initial proposals and ongoing discussions in the Application Directory FDC3 working group. The purpose of this POC is to:

  • Define an intial interface through an OpenAPI sepcification
  • Start to ratify schema/models
  • Generate example server stubs for java and nodejs
  • Generate example client binding for java

View it in a nice swagger editor

Build

Compilation requires jdk 8+ and maven

Build:

#git clone..*:
#cd cloned_directory
#mvn clean install package

Directory structure

  • appd-api/specification: Contains the OpenAPI specification for interfaces and models. View it here
  • appd-api/appd-java-server-stubs: Contains the generated java server stubs (jaxrs/Jersey2) which the application server implements. After build, you can reference the stubs using the following dependency.
    <dependency>
       <groupId>org.fdc3.appd</groupId>
       <artifactId>appd-server-stubs</artifactId>
       <version>0.0.1-SNAPSHOT</version>
    </dependency>
    
  • appd-api/appd-nodejs-server-stubs: Contains the generated nodejs server stubs.
  • appd-api/appd-jersey-client: Contains a java (jersey2) client binding to the application directory

Example implementation

Please see the Application Directory POC for an implementation of the specification.

appd-api's People

Contributors

ftbb avatar richlinnell avatar lspiro-tick42 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.