Active Projects
Completed Projects
-
API Town Plan —
Project purpose
As more and more UN/CEFACT business domains publish API standards, there is a risk of confusion and overlaps/gaps unless there is a well-managed architecture where every domain knows where they fit and all users can easily navigate the plan to find the APIs they need. This project will establish a high level “API town plan” and associated governance and publishing framework for all UN/CEFACT APIs. This project will be complete and proven successful when:
- A first draft API town plan is published: As a clickable map covering Trade, Transport, Regulatory, and Financial domains as well as agriculture, tourism and other domains.
- A town plan governance framework is established: That defines how the town plan is managed and how new APIs are added.
- Conformant API Implementations are published: At least two domains have each followed the RDM2API methodology and have published at least one API that aligns with the town plan.
Project scope
The green boxes on the right of the diagram represent a conceptual vision of the published town plan.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
RDM2API —
Project purpose
To define a standard methodology that can be used to produce high quality OpenAPI specifications and JSON-LD dictionaries from existing UN/CEFACT semantic library content, particularly the Reference Data Models (RDM). The methodology will be complete and proven successful when users can:
- Re-use our semantics: UN/CEFACT library content (RDM) can be imported into any conformant modelling tool or semantic tool.
- Model consistently: API Resource / Event models and JSON-LD dictionaries can be created in any conformant modelling tool and easily mapped to the imported RDM definitions.
- Publish specifications: API reference specifications (Including Open API3.0 and JSON-LD) can be generated from the modelling tool and published to open platforms such as Github.
- Test conformance of their implementations. Actual API implementations can be tested against the reference specifications and a conformance report generated.
We will know this work is successful when the world wide community of web developers are actively using UN/CEFACT semantic standards in their Trade & Transport system Web APIs.
Project scope
The dark blue boxes on the architecture diagram below highlight the specific work items in this work package.
