API First Strategy · • ASP.NET Core 1.0 • Go Server • NancyFX 46 Swagger Codegen (Server...

API First StrategyDesign, Develop, and Manage APIs on the Cloud

Young Gyu Kim Principal Sales Consultant Oracle Korea, Cloud Platform August 30, 2017

Safe Harbor Statement

The following is intended to outline our general product direction. It is intended for information purposes only, and may not be incorporated into any contract. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described for Oracle’s products remains at the sole discretion of Oracle.

Confidential – Oracle Internal/Restricted/Highly Restricted 2

Program Agenda

Open API Initiative & Open API Specification

How to Design an API

How to Develop an API

How to Test an API

How to Deploy an API

How to Manage an API

Open API Initiative & SpecificationOAI OAS

2011.07

2013.04

2013.09

2014.05

2015.11

2016.01

2017.04

SwaggerInitial

Commit

OPEN API InitiativeOpenAPI Spec 2.0

(Swagger Spec 2.0)

API BlueprintInitial

Commit

Swagger Spec 2.0GlueCon 2014

in Colorado

API Blueprint Joined OAI

RAMLInitial

Commit

Joined OAI

2017.07

Swagger Spec 3.0

MuleSoft Joins the OpenAPI Initiative: The End of the API Spec Wars

Open API and RAML: Better Together

How to Design an APISwagger, API Blueprint, RAML

Transform API Descriptions https://apimatic.io/transformer

Apiary supports Swagger

API Blueprint Editor

Swagger Editor

Validate API Spec

Preview

Github Integration

API Documentation

TEST through Mock Server

TEST through production Server

Request / Response Header

Response Data

Generate Client Source (Code Snippet)cURL, Java, Javascript, Node.JS, Perl, Python, PHP, Ruby, Go, C#, Visual Basic, Groovy, Object-C, Swift

Java Source Code (maven)

<groupId>org.glassfish.jersey.core</groupId><artifactId>jersey-client</artifactId><version>2.8</version>

</dependency><dependency>

<groupId>org.glassfish.jersey.media</groupId><artifactId>jersey-media-json-jackson</artifactId><version>2.8</version>

</dependency></dependencies>

package com.apiarytest.msr.msrclient;

import javax.ws.rs.client.Client;import javax.ws.rs.client.ClientBuilder;import javax.ws.rs.client.Entity;import javax.ws.rs.core.Response;import javax.ws.rs.core.MediaType;

public class ApiCustomer {public static void main(String[] args) {

Client client = ClientBuilder.newClient();Response response = client.target("https://private-15a7b-credemol.apiary-mock.com/search")

.request(MediaType.TEXT_PLAIN_TYPE).get();

System.out.println("status: " + response.getStatus());System.out.println("headers: " + response.getHeaders());System.out.println("body:" + response.readEntity(String.class));

Generate Server (eg, spring boot)

Generate Client (eg, java client)

Design YAML editor with basic style validationCloud-based YAML editor with predesigned templates, simultaneous style feedback, mocking, and

hosting for API definitions

Develop Code generation with Swagger CodeGenCode generation in 20+ server languages, which can automatically sync with source control hosts like

GitHub, Bitbucket, and GitLab

DocumentInteractive API documentation and

sandbox with SwaggerUI

Interactive API documentation and sandbox, and auto-generation for client SDKs, all hosted in the

cloud with privacy controls

Mock NO Generate a mock of your API to virtualize operations without writing any code

Host NOSecure cloud-based hosting for Swagger definitions and API documentation, with built-in access

controls

Collaborate NOReal-time issue tracking and conversations, team management, role assignment, and permission/

access controls

Deploy NOQuickly deploy your API definitions to API Gateways such as AWS , Microsoft Azure and IBM API

Connect. Automatically generate AWS Lambda functions for serverless deployments.

Version NO Manage multiple versions of API definitions, and retire outdated APIs

Transform API Descriptions to formats of your choice

How to Develop an APISwagger Codegen

https://github.com/swagger-api/swagger-codegenInstall Swagger Codegen

$ wget http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.2.3/swagger-codegen-cli-2.2.3.jar -O swagger-codegen-cli.jar

$ java -jar swagger-codegen-cli.jar

$ brew install swagger-codegen

Java Version

Homebrew (OS X)

• Erlang• Node.js• PHP Lumen• PHP Slim• PHP Silex• Python Flask (Connexion)• Python2 Flask (Connexion)• Ruby on Rails5• Ruby Sinatra• Scala Scalatra• Haskell Servant• ASP.NET Core 1.0• Go Server• NancyFX

Swagger Codegen (Server Stub): 23• Java JAX-RS 2.0 spec• Java JAX-RS (Java JAX-RS (Jersey)• Java JAX-RS (Apache CXF 2 / 3)• Java JAX-RS (Resteasy)• Java JAX-RS (Apache CXF

framework on Java EE server supporting CDI)

• Java Spring MVC• Java SpringBoot• Java Undertow• Java MSF4J

• async-scala

• csharp

• cpprest (C++, https://github.com/Microsoft/cpprestsdk)

• dart

• flash

• go

• groovy

• java

• jaxrs-cxf-client

• javascript

• javascript-closure-angular

Swagger Codegen (API Client): 32• jmeter

• nancyfx

• nodejs-server

• objc

• perl

• php

• python

• qt5cpp (C++, https://www.qt.io/)

• ruby

• scala

• swift

• swift3

• tizen

• typescript-angular2

• typescript-angular

• typescript-node

• typescript-fetch

• akka-scala

• CsharpDotNet2

• clojure

• haskell

swagger-codegen-cli generate [(-a <authorization> | --auth <authorization>)] [--additional-properties <additional properties>...] [--api-package <api package>] [--artifact-id <artifact id>] [--artifact-version <artifact version>] [(-c <configuration file> | --config <configuration file>)] [-D <system properties>...] [--git-repo-id <git repo id>] [--git-user-id <git user id>] [--group-id <group id>] [--http-user-agent <http user agent>] (-i <spec file> | --input-spec <spec file>) [--ignore-file-override <ignore file override location>] [--import-mappings <import mappings>...] [--instantiation-types <instantiation types>...] [--invoker-package <invoker package>] (-l <language> | --lang <language>) [--language-specific-primitives <language specific primitives>...] [--library <library>] [--model-name-prefix <model name prefix>] [--model-name-suffix <model name suffix>] [--model-package <model package>] [(-o <output directory> | --output <output directory>)] [--release-note <release note>] [--remove-operation-id-prefix] [--reserved-words-mappings <reserved word mappings>...] [(-s | --skip-overwrite)] [(-t <template directory> | --template-dir <template directory>)] [--type-mappings <type mappings>...] [(-v | --verbose)]

Generate SpringBoot application

$ swagger-codegen generate -v -i "swagger-msr.yaml" \ -l "spring" -o "acme-msr-api" \ --api-package "com.acme.msr.api" \ --model-package "com.acme.msr.model" \ --model-name-suffix "VO" \ --artifact-id "acme-msr-api" \ --group-id "com.acme.msa"

$ cd acme-msr-api

$ mvn clean package

$ mvn spring-boot:run

http://localhost:8080/api/swagger-ui.html

http://localhost:8080/api/api-docs (api-docs.json)

Swagger2StringBoot.java@SpringBootApplication @EnableSwagger2 @EnableJpaRepositories("com.acme.msr.repository") @ComponentScan(basePackages = { "io.swagger","com.acme.msr.service","com.acme.msr.api" }) @EntityScan("com.acme.msr.entity") public class Swagger2SpringBoot implements CommandLineRunner {

@Override public void run(String... arg0) throws Exception { if (arg0.length > 0 && arg0[0].equals("exitcode")) { throw new ExitException(); } }

SeatApiController.java - findSeats() public ResponseEntity<List<SeatVO>> findSeats(@ApiParam(value = "seatNo to filter by") @RequestParam(value = "seatNo", required = false) String seatNo, @ApiParam(value = "maximum number of results to return") @RequestParam(value = "limit", required = false) Integer limit) {

List<Seat> seats = null; if(seatNo == null || seatNo.trim().length() == 0) { seats = new ArrayList<Seat>(); seatRepository.findAll().iterator().forEachRemaining(seats::add); } else { seats = seatRepository.findBySeatNoLike(seatNo); } List<SeatVO> voList = seats.stream().map(this::convertToVO).collect(Collectors.toList());

return new ResponseEntity<List<SeatVO>>(voList, HttpStatus.OK); }

Service 를 활용한 비즈니스 로직 추상화

public ResponseEntity<List<SeatVO>> findSeats(@ApiParam(value = "seatNo to filter by") @RequestParam(value = "seatNo", required = false) String seatNo, @ApiParam(value = "maximum number of results to return") @RequestParam(value = "limit", required = false) Integer limit) {

List<Seat> seats = seatService.findSeats(seatNo);

List<SeatVO> voList = seats.stream().map(this::convertToVO).collect(Collectors.toList()); return new ResponseEntity<List<SeatVO>>(voList, HttpStatus.OK);

return new ResponseEntity<List<SeatVO>>(voList, HttpStatus.OK); }

Generate Node.JS application

$ swagger-codegen generate -v -i swagger-petstore.yaml -l nodejs-server -o swagger-petstore-nodejs$ cd swagger-petstore-nodejs

$ npm start

#$ npm install #$ node index

http://localhost:8080/docs

HTTP API Testing FrameworkDredd

Supported API Descriptions Format

Supported Hooks Languages

Supported Systems (OS & CI)

run dredd with hooks file$ dredd ../swagger-msr.yaml http://localhost:8080 -f hooks.js

info: Beginning Dredd testing... info: Found Hookfiles: 0=/Users/nicholas/git/api-first-strategy/dredd/hooks.js pass: GET /api/seats duration: 80ms fail: POST /api/seats duration: 21ms pass: GET /api/seats/1 duration: 24ms fail: PUT /api/seats/1 duration: 13ms fail: DELETE /api/seats/1 duration: 23ms fail: GET /api/reservations?status=available duration: 25ms fail: POST /api/reservations duration: 16ms fail: GET /api/reservations/findByUser/1 duration: 21ms fail: GET /api/reservations/1 duration: 26ms fail: DELETE /api/reservations/1 duration: 14ms fail: PUT /api/reservations/1 duration: 17ms info: Displaying failed tests... fail: POST /api/seats duration: 21ms fail: headers: Header 'content-type' is missing

hooks.js

var hooks = require('hooks');

hooks.beforeEachValidation(function(transaction, done) { var contentType = transaction.real.headers['content-type']; console.log("#### BefereEachValidation contentType", contentType);

if(contentType === 'application/json;charset=UTF-8') { transaction.real.headers['content-type'] = 'application/json'; }

done(); });

How to deploy an APICloud, Docker, OnPremises

There are many options to deploy your API

On Premise Data Center Cloud Data Center Container

Run API on the Cloud

Polyglots

Deploy API to Docker Container

$ mvn package$ vi Dockerfile

$ docker build -t acme-msr-api:1 .$ docker run -d --name acme-msr-api -p 8080:8080 acme-msr-api:1

FROM openjdk:8-jdk-alpine COPY target/acme-msr-api-1.0.0.jar /deployments/

CMD java -jar /deployments/acme-msr-api-1.0.0.jar

How to Manage an APIAPI Gateway

Need for an API

Management Service

GatewaysGatewaysGateways

Sales Cloud

ServicesDMZ (Optional)

Cloud or On-Premise

Management PortalDeveloper Portal

Applications

Custom

On-Premise

One design, many instances.Centralized API Design, Distributed API Runtime

Oracle Cloud

Amazon, Azure, other

clouds

On Premises

Gateways

API Management using Policies

https://youtu.be/wN2xMjCDN6Y

Publish API using Apiary

https://youtu.be/9kF8SXcLpNI

API First Strategy · • ASP.NET Core 1.0 • Go Server • NancyFX 46 Swagger Codegen (Server...

Documents

Transcript of API First Strategy · • ASP.NET Core 1.0 • Go Server • NancyFX 46 Swagger Codegen (Server...

Java Web Services [5/5]: REST and JAX-RS

Web Service and JAX-RS · JAX-RS RESTfulWeb Services with JAX-RS Java API for RESTfulWeb Services JAX-RS is a Java programming language API Make it easy to develop applications that

JAX-RS: Java API for RESTful Web Servicesdownload.oracle.com/otn-pub/jcp/jaxrs-1.0-pr-oth-JSpec/...JAX-RS: Java API for RESTful Web Services Public Review Draft April 18, 2008 Editors:

JAX-RS: Java API for RESTful Web Servicesdownload.oracle.com/otn-pub/jcp/jaxrs-2_0-pr-spec/339...JAX-RS: Java API for RESTful Web Services Version 2.0 Public Review September 26, 2012

RESTEasy JAX-RS - JBoss...JAX-RS 2.0 (JSR-339) and JAX-RS 2.1 (JSR-370), are JCP specifications that provide a Java API for RESTful Web Services over the HTTP protocol. RESTEasy is

[2016-02-16] Java RESTful API with JAX-RS

JAX-RS 2.1 Reloaded€¦ · #DevoxxUS JAX-RS 2.1 Reloaded Santiago Pericas-Geertsen JAX-RS Co-Spec Lead #jax-rs @spericas

Développer des Services Web REST avec Java : JAX-RS

JAX-RS: The Java API for RESTful Web Serviceskrunapon/trainings/javaws/slides/Intro2JAX-R… · JAX-RS: The Java API for RESTful Web Services Asst. Prof. Dr. Kanda Runapongsa Saikaew

JAX-RS 2.0: RESTful Java on Steroids

Java EE - SCSK株式会社 · Java EE 6 JAX-RS, CDI, Servlet 3.0, Web Profile, Pruning Java EE 7 JAX-RS 2.0, JSON-P, WebSocket, JMS 2.0, Batch J2EE 1.2 Servlet, JSP, EJB, JMS Java

JAX-RS: Java API for RESTful Web Services - Oracledownload.oracle.com/otn-pub/jcp/jaxrs-2_1-final-eval-spec/jaxrs-2... · JAX-RS: Java™ API for RESTful Web Services Version 2.1

Eclipse Day India 2015 - Rest with Java (jax rs) and jersey

Java Persistence API RESTful Web Services JAX-RS Technical … · Java Persistence API RESTful Web Services JAX-RS Technical Introduction Matthew Perrins Executive IT Specialist Martin

Advanced Java API for RESTful Web Services (JAX-RS)

JAX-WS e JAX-RS

JAX-RS: Java API for RESTful Web Services - Oracle...JAX-RS: Java API for RESTful Web Services Version 2.0 Early Draft (Third Edition) May 25, 2012 Editors: Santiago Pericas-Geertsen

Creating Java JAX-RS Servers from Swagger API definitionsnomossoftware nomos-software.com Creating Java JAX-RS Servers from Swagger API definitions London Java Community Meetup, Docklands,

RESTful Web Services mit JAX-RS - fh-muenster.de · 2014-12-10 · RESTful Web Services mit JAX-RS ... 4 Praktikum. MotivationRESTJAX-RSPraktikum Was ist JAX-RS? •Java API for RESTful

RESTful Java with JAX-RS - PROIDEA · RESTful Java with JAX-RS Bill Burke Engineering Fellow Red Hat . 2 4XLFN7LPH DQGD decompressor Agenda are needed to see this picture.