Skip to content

Instantly share code, notes, and snippets.

View jccguimaraes's full-sized avatar
🏠

João Guimarães jccguimaraes

🏠
View GitHub Profile

Keybase proof

I hereby claim:

  • I am jccguimaraes on github.
  • I am jguimaraes (https://keybase.io/jguimaraes) on keybase.
  • I have a public key ASAjC0-bUddQzbMhJjfmqFb0UYGie7RlNjYLIQOg0WHtCgo

To claim this, I am signing this object:

@jccguimaraes
jccguimaraes / post-design-an-api-capture.puml
Last active February 23, 2019 09:46
PlantUML /capture sequence diagram
@startuml
participant "USER" as A
participant "MS" as B
participant "API" as C
title //process-transactions// micro-service capture workflow
rnote left A
**headers**
@jccguimaraes
jccguimaraes / post-design-an-api-openapi.yaml
Created February 23, 2019 09:48
Post - Design an API - OpenAPI Spec file
openapi: 3.0.2
tags:
- name: capture
info:
version: 1.0.0
title: Process Transactions Micro-service
description: 'Capture, void and refund an account.'
paths:
'/capture/{authorizationId}':
post:
@jccguimaraes
jccguimaraes / post-design-an-api-open-api-index.yaml
Created February 27, 2019 00:52
Content of `./open-api/index.yaml`:
openapi: 3.0.2
tags:
- name: capture
info:
$ref: './info.yaml'
paths:
$ref: './paths.yaml'
components:
$ref: './components.yaml'
security:
@jccguimaraes
jccguimaraes / post-design-an-api-open-api-paths.yaml
Created February 27, 2019 00:55
Content of `./open-api/paths.yaml`:
/capture/{authorizationId}:
post:
$ref: './paths/capture.yaml'
@jccguimaraes
jccguimaraes / post-design-an-api-open-api-capture.yaml
Created February 27, 2019 00:56
Content of `./open-api/paths/capture.yaml`:
summary: Capture an amount
tags:
- capture
operationId: capturePost
parameters:
- $ref: '../components/parameters/authorization-id.yaml'
- $ref: '../components/parameters/x-correlation-id.yaml'
requestBody:
content:
application/json:
@jccguimaraes
jccguimaraes / post-design-an-api-plantuml-example.puml
Created February 27, 2019 11:12
Simple example taken from PlantUML
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: Another authentication Response
@enduml