JarCasting
JarCasting JarCasting

yop-demo

This is a a demo for YOP : a simple web-app where you can submit Yopable code and test it using swagger. Ω≡{Ⓐ}

License

License

Postcard Public License
GroupId

GroupId

org.y-op
ArtifactId

ArtifactId

demo
Last Version

Last Version

0.9.0
Release Date

Release Date
Type

Type

war
Description

Description

yop-demo
This is a a demo for YOP : a simple web-app where you can submit Yopable code and test it using swagger. Ω≡{Ⓐ}
Project URL

Project URL

http://demo.y-op.org

Download demo

Filename Size
demo-0.9.0.pom
demo-0.9.0.war 19 MB
demo-0.9.0-sources.jar 12 KB
demo-0.9.0-javadoc.jar 61 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.y-op/demo/ -->
<dependency>
    <groupId>org.y-op</groupId>
    <artifactId>demo</artifactId>
    <version>0.9.0</version>
    <type>war</type>
</dependency>
// https://jarcasting.com/artifacts/org.y-op/demo/
implementation 'org.y-op:demo:0.9.0'
// https://jarcasting.com/artifacts/org.y-op/demo/
implementation ("org.y-op:demo:0.9.0")
'org.y-op:demo:war:0.9.0'
<dependency org="org.y-op" name="demo" rev="0.9.0">
  <artifact name="demo" type="war" />
</dependency>
@Grapes(
@Grab(group='org.y-op', module='demo', version='0.9.0')
)
libraryDependencies += "org.y-op" % "demo" % "0.9.0"
[org.y-op/demo "0.9.0"]

Dependencies

compile (10)

Group / Artifact Type Version
org.y-op : orm jar 0.9.0
org.y-op : rest jar 0.9.0
org.y-op : swaggerui jar 0.9.0
org.slf4j : slf4j-api jar 1.7.7
ch.qos.logback : logback-classic jar 1.1.2
ch.qos.logback : logback-core jar 1.1.2
commons-io : commons-io jar 2.4
org.apache.commons : commons-lang3 jar 3.7
org.apache.commons : commons-exec jar 1.3
org.xerial : sqlite-jdbc jar 3.21.0.1

provided (1)

Group / Artifact Type Version
javax.servlet : javax.servlet-api jar 3.1.0

Project Modules

There are no modules declared in this project.

YOP !

YOP is an ORM tool.
And since I am such a nice guy, a REST stack is built on top of it.

Status

Build Status

Modules :

Maven

Yop modules are available on Maven central :

<dependency>
    <groupId>org.y-op</groupId>
    <artifactId>reflection</artifactId>
    <version>0.9.0</version>
</dependency>
<dependency>
    <groupId>org.y-op</groupId>
    <artifactId>ioc</artifactId>
    <version>0.9.0</version>
</dependency>
<dependency>
    <groupId>org.y-op</groupId>
    <artifactId>orm</artifactId>
    <version>0.9.0</version>
</dependency>
<dependency>
    <groupId>org.y-op</groupId>
    <artifactId>rest</artifactId>
    <version>0.9.0</version>
</dependency>
<dependency>
    <groupId>org.y-op</groupId>
    <artifactId>swaggerui</artifactId>
    <version>0.9.0</version>
</dependency>

About

Yop is an ORM tool with a conventional REST webservice Servlet. Webservices are described using OpenAPI specifications

Structure :

The ORM module brings a set of query builders with an SQL like syntax :

Select   
 .from(Library.class)    
 .join(Library::getAuthors, Author::getBooks, Book::getChapters)    
 .join(Library::getEmployees)  
 .execute(connection);

The REST module brings a set of annotations to directly expose the data objects as REST resources :

@Rest(
  path="book",
  summary = "Rest resource for books !",
  description = "A collection of sheets of paper bound together to hinge at one edge."
)
@Table(name="book")
public class Book implements Yopable {}

A REST servlet can expose the data objects as REST resources :

Wrapper wrapper = Tomcat.addServlet(context, YopRestServlet.class.getSimpleName(), new YopRestServlet());

// The data objects packages exposed as REST resources
wrapper.addInitParameter(YopRestServlet.PACKAGE_INIT_PARAM, "org.yop");

// The datasource JNDI name (or you can override the 'getConnection' method)
wrapper.addInitParameter(YopRestServlet.DATASOURCE_JNDI_INIT_PARAM, "datasource");

// The exposition path for the data objects REST resources
context.addServletMappingDecoded("/yop/rest/*", YopRestServletWithConnection.class.getSimpleName());

The OpenAPI description of data objects can be generated and exposed using a Servlet :

Wrapper wrapper = Tomcat.addServlet(context, OpenAPIServlet.class.getSimpleName(), new OpenAPIServlet());

// The data objects packages exposed as REST resources
wrapper.addInitParameter(OpenAPIServlet.PACKAGE_INIT_PARAM, "org.yop");

// The exposition path for the data objects REST resources
wrapper.addInitParameter(OpenAPIServlet.EXPOSITION_PATH_PARAM, "/yop/rest");

// The exposition path for the generated OpenAPI description of the data objects REST resources
context.addServletMappingDecoded("/yop/openapi", OpenAPIServlet.class.getSimpleName());

Miscellaneous / Philosophy

  • Data objects describe their REST and/or ORM features.
  • CRUD behavior in REST services is conventional.
  • Data objects carry any extra CRUD behavior (i.e beyond conventional) to be exposed in REST services.
  • Explicit CRUD can be achieved using the orm module in an SQL like syntax.
  • DAO pattern sucks.
  • DTO pattern sucks.
  • YOP naively aims at being a straightforward Model-Driven ORM/REST stack.

Versions

Version
0.9.0