0b9549bd3e
* [JAVA-13854] added parent module * [JAVA-13854] moved apache-tapestry(submodule) to web-modules(parent) * [JAVA-13854] moved bootique(submodule) to web-modules(parent) * [JAVA-13854] moved dropwizard(submodule) to web-modules(parent) * [JAVA-13854] moved blade(submodule) to web-modules(parent) * [JAVA-13854] moved java-lite(submodule) to web-modules(parent) * [JAVA-13854] moved jooby(submodule) to web-modules(parent) * [JAVA-13854] moved linkrest(submodule) to web-modules(parent) * [JAVA-13854] moved ninja(submodule) to web-modules(parent) * [JAVA-13854] moved ratpack(submodule) to web-modules(parent) * [JAVA-13854] moved resteasy(submodule) to web-modules(parent) * [JAVA-13854] moved restx(submodule) to web-modules(parent) * [JAVA-13854] moved spark-java(submodule) to web-modules(parent) * [JAVA-13854] moved vraptor(submodule) to web-modules(parent) * [JAVA-13854] delete modules that were moved * [JAVA-13854] * [JAVA-13854] * [JAVA-13854] delete ninja submodule + moved raml(submodule) to web-modules(parent) * [JAVA-13854] moved gwt(submodule) to web-modules(parent) * [JAVA-13854] moved jakarta-ee(submodule) to web-modules(parent) * [JAVA-13854] moved javax-servlets(submodule) to web-modules(parent) * [JAVA-13854] moved javax-servlets-2(submodule) to web-modules(parent) * [JAVA-13854] moved jee-7(submodule) to web-modules(parent) * [JAVA-13854] moved play-framework(not a module) to web-modules * [JAVA-13854] fix failing test * [JAVA-13854] moved struts-2(submodule) to web-modules(parent) * [JAVA-13854] moved wicket(submodule) to web-modules(parent) * [JAVA-13854] deleted modules that were moved to web-modules * JAVA-13854 Removed moved modules from the main pom.xml Co-authored-by: panagiotiskakos <panagiotis.kakos@libra-is.com> Co-authored-by: Dhawal Kapil <dhawalkapil@gmail.com>
101 lines
2.7 KiB
Plaintext
101 lines
2.7 KiB
Plaintext
#%RAML 1.0
|
|
title: Baeldung Foo REST Services API
|
|
version: v1
|
|
protocols: [ HTTPS ]
|
|
baseUri: http://rest-api.baeldung.com/api/{version}
|
|
mediaType: application/json
|
|
securedBy: basicAuth
|
|
securitySchemes:
|
|
- basicAuth:
|
|
description: Each request must contain the headers necessary for
|
|
basic authentication
|
|
type: Basic Authentication
|
|
describedBy:
|
|
headers:
|
|
Authorization:
|
|
description: Used to send the Base64 encoded "username:password"
|
|
credentials
|
|
type: string
|
|
responses:
|
|
401:
|
|
description: |
|
|
Unauthorized. Either the provided username and password
|
|
combination is invalid, or the user is not allowed to access
|
|
the content provided by the requested URL.
|
|
types:
|
|
Foo: !include types/Foo.raml
|
|
Error: !include types/Error.raml
|
|
/foos:
|
|
get:
|
|
description: List all Foos matching query criteria, if provided;
|
|
otherwise list all Foos
|
|
queryParameters:
|
|
name?: string
|
|
ownerName?: string
|
|
responses:
|
|
200:
|
|
body:
|
|
application/json:
|
|
type: Foo[]
|
|
example: !include examples/Foos.json
|
|
post:
|
|
description: Create a new Foo
|
|
body:
|
|
application/json:
|
|
type: Foo
|
|
example: !include examples/Foo.json
|
|
responses:
|
|
201:
|
|
body:
|
|
application/json:
|
|
type: Foo
|
|
example: !include examples/Foo.json
|
|
/{id}:
|
|
get:
|
|
description: Get a Foo by id
|
|
responses:
|
|
200:
|
|
body:
|
|
application/json:
|
|
type: Foo
|
|
example: !include examples/Foo.json
|
|
404:
|
|
body:
|
|
application/json:
|
|
type: Error
|
|
example: !include examples/Error.json
|
|
put:
|
|
description: Update a Foo by id
|
|
body:
|
|
application/json:
|
|
type: Foo
|
|
example: !include examples/Foo.json
|
|
responses:
|
|
200:
|
|
body:
|
|
application/json:
|
|
type: Foo
|
|
example: !include examples/Foo.json
|
|
404:
|
|
body:
|
|
application/json:
|
|
type: Error
|
|
example: !include examples/Error.json
|
|
delete:
|
|
description: Delete a Foo by id
|
|
responses:
|
|
204:
|
|
404:
|
|
body:
|
|
application/json:
|
|
type: Error
|
|
example: !include examples/Error.json
|
|
/name/{name}:
|
|
get:
|
|
description: List all Foos with a certain name
|
|
responses:
|
|
200:
|
|
body:
|
|
application/json:
|
|
type: Foo[]
|
|
example: !include examples/Foos.json |