api

License	MIT
GroupId	io.github.definiti
ArtifactId	api
Last Version	0.3.0
Release Date	Jul 28, 2018
Type	jar
Description	api api
Project URL	https://definiti.gitbook.io/definiti
Project Organization	io.github.definiti
Source Code Management	https://github.com/definiti/definiti-api

Download api

Filename	Size
api-0.3.0.pom
api-0.3.0.jar	6 KB
api-0.3.0-sources.jar	5 KB
api-0.3.0-javadoc.jar	257 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.github.definiti/api/ -->
<dependency>
    <groupId>io.github.definiti</groupId>
    <artifactId>api</artifactId>
    <version>0.3.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.github.definiti/api/
implementation 'io.github.definiti:api:0.3.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.github.definiti/api/
implementation ("io.github.definiti:api:0.3.0")

Apache Buildr

'io.github.definiti:api:jar:0.3.0'

Apache Ivy

<dependency org="io.github.definiti" name="api" rev="0.3.0">
  <artifact name="api" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.github.definiti', module='api', version='0.3.0')
)

Scala SBT

libraryDependencies += "io.github.definiti" % "api" % "0.3.0"

Leiningen

[io.github.definiti/api "0.3.0"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.scala-lang : scala-library	jar	2.12.6

Project Modules

There are no modules declared in this project.

Definiti - API

For core project, see Definiti/Definiti.

About this project

This project defines the API for the Definiti project. It focuses on the API definition, not its implementation in all plugins.

While this project is the reference for all plugin implementations, it does not guaranty its full implementation. Please refer to specific plugins to know their compatibility.

Project structure

The project structure is the following:

 definiti-api/
 |
 |-- src/                       # All API files
 |   |-- Boolean.definition     # Definition of Boolean type
 |   |-- Date.definition        # Definition of Date type
 |   |-- ...
 |
 |-- examples/                  # Example of use of the API
 |   |-- Boolean/               # Type Boolean
 |   |   |-- Boolean.def        # Usage in Definiti language
 |   |   |-- Boolean.js         # Usage in Javascript language
 |   |   |-- Boolean.scala      # Usage in Scala language
 |   |   |-- ...
 |   |-- ...
 |
 |-- tests/                     # Test examples to verify the API is valid
 |   |-- Boolean/               # Type Boolean
 |   |   |-- Boolean.js         # Tests in Javascript language
 |   |   |-- Boolean.scala      # Tests in Scala language

How to improve this API

You can submit anytime your pull-request:

• Clone the repository
• Add or update the type you want
• Define the documentation
• Create example in at least one language
• Create tests in at least one language
• Make the pull-request

After reviews by other members of the community and project members, when the PR seems good enough, it will be merged for the next release.

Versions

Version
0.3.0 Jul 28, 2018