com.github.mmuller88.alpsUnifiedTs.package-info Maven / Gradle / Ivy
/**
* 
* 
* 
* 
* 
*
*
alps-unified-ts
*
* That is an enhanced TypeScript library of alps-unified. With it you can convert an ALPS API spec to other API spec like openApi, Graph QL Schema.
*
* Very useful to understand the idea of ALPS API is this video on YouTube: https://www.youtube.com/watch?v=oG6-r3UdenE
*
* Want to know more about ALPS? --> please visit:
*
*
* - http://alps.io/
* - https://github.com/alps-io/
* - https://github.com/mamund/alps-unified
*
*
*
Features
*
*
* - generating and publishing alps unified libraries for JavaScript, TypeScript, Python, Java and .NET
* - Type support for ALPS specs (see example 'Create from Spec' down below)
*
*
*
Examples
*
*
Load from YAML file
*
* You can load the ALPS spec directly from a YAML file. JSON ist atm not supported.
*
*
Convert to OpenApi
*
*
* // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
* Alps.unified(Alps.loadYaml("test/todo-alps.yaml"), Map.of(
* "formatType", FormatType.getOPENAPI()));
*
*
*
Convert to GraphQL Schema
*
*
* // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
* Alps.unified(Alps.loadYaml("test/todo-alps.yaml"), Map.of(
* "formatType", FormatType.getSDL()));
*
*
*
Create from Spec
*
* Creating the API specification from the spec is very powerful. As it gives you much support in an idea like VS as it is typed and documented. So you alway produce valid API specs.
*
*
* // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
* Alps.unified(Alps.spec(Map.of(
* "alps", Map.of(
* "version", "1.0",
* "doc", Map.of(
* "value", "Simple Todo list example"),
* "ext", asList(Map.of(
* "type", "metadata",
* "name", "title",
* "value", "simpleTodo",
* "tags", "oas"), Map.of(
* "type", "metadata",
* "name", "root",
* "value", "http://api.example.org/todo",
* "tags", "oas")),
* "descriptor", asList(Map.of(
* "id", "id",
* "type", "semantic",
* "text", "storage id of todo item"))))));
*
*
* For Python to benefit from the types better do this:
*
*
* import alps_unified_ts as alps
*
* alps_def = alps.AlpsDef(
* version='1.0',
* descriptor=[alps.DescriptorDef(id="id", type="semantic", text="sotrage id of todo item")],
* doc=alps.DocDef(
* value="Simple Todo list example"),
* ext=[
* alps.ExtDef(
* name="root",
* tags="oas",
* type="metadata",
* value="http://api.example.org/todo"),
* alps.ExtDef(
* name="title",
* tags="oas",
* type="metadata",
* value="simpleTodo")])
*
* alps.Alps.unified(alps_document=alps.Alps.spec(alps=alps_def), format_type=alps.FormatType.OPENAPI)
*
*
*
Thanks to
*
*
* - The AWS CDK Community for the repo tool projen which I use for this repo.
*
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
package com.github.mmuller88.alpsUnifiedTs;