Skip to content

Latest commit

 

History

History
182 lines (118 loc) · 4.41 KB

PITCHME.md

File metadata and controls

182 lines (118 loc) · 4.41 KB

Vapor Workshop

The Swift Alps

Crans Montana – Switzerland

Thursday, November 23rd, 2017

@fa[cloud] Vapor

  • Creation of a Notes API using Vapor 2.0
  • Specifications through an ad-hoc "Validator" project
  • Vapor ready to use in a Docker image
  • Team with highest number of green tests wins!

@fa[picture-o] Docker

  • Ready-to-use Docker image contains Swift 4, Vapor 2, SQLite, tmux, zsh…
    • Based on Phusion Base Image
    • Dockerfiles available for reference
    • User developer, password developer
    • Can be used interactively
    • Local Desktop becomes image desktop

@fa[arrows-alt] ngrok

  • Simple reverse forwarding for your API
  • Provide me with the temporary URL for your API at the end of the exercise

@fa[file-text] API Specs 1/3

  • The API responds to a "ping"
  • Anyone can create a new user in the system
  • Logged-in users can create notes
  • Default user:

@fa[file-text] API Specs 2/3

  • Notes are identified using UUIDs
  • Notes contain Markdown text
  • Users can get all of their notes
  • …get one single note
  • …edit a single note
  • …delete a single note

@fa[file-text] API Specs 3/3

  • …delete all notes at once
  • …publish a note in HTML
  • …unpublish notes
  • …request a backup of their notes in ZIP format
  • …search their notes for the occurrence of a string

@fa[check] Validator

  • Swift package
  • macOS & Linux
  • Makefile for common tasks
  • Dockerfiles available in docker project for reference

---?code=Sources/Infrastructure/BaseScenario.swift&title=Assertions&lang=swift @[191-195](Asserting for "Content-Type" headers) @[204-208](Asserting for response status codes) @[231-233](Asserting for particular headers)

---?code=Sources/Scenarios/PingScenario.swift&title=Ping Scenario&lang=swift @[18-29](Example scenario)

---?code=Sources/Infrastructure/API.swift&title=API Wrapper&lang=swift @[37-48](Log in) @[29-31](Create user) @159-161

@fa[sort-numeric-desc] Points

  • GET & DELETE requests: 3 points
  • POST & PUT requests: 5 points
  • ZIP Backup: 10 points

Maximum Score: 152 Points

@fa[street-view] Demo

asciicast

@fa[briefcase] Working Tips

  • Study Sources/Scenarios & Sources/Infrastructure/API.swift
  • Start with the easiest possible endpoint: ping
  • Vapor provides a lot!
    • Use an in-memory SQLite database for storage
    • ZIP archive is the most difficult part
    • Middlewares!

@fa[comments] Vapor Cheatsheet

  • vapor new Notes --template=api
  • vapor build
  • vapor run serve
  • vapor xcode
  • vapor clean

@fa[comments] Docker Cheatsheet

  • sudo docker run --interactive --tty --privileged --publish 80:8080 --user=developer --volume ~/Desktop:/home/developer/Desktop akosma/vapor zsh
  • docker container list
  • docker images

@fa[comments] ngrok Cheatsheet

@fa[keyboard-o] curl Cheatsheet 1/3

  • curl http://localhost/ping

  • curl http://localhost/api/v1/login --silent --user "vapor@theswiftalps.com:swiftalps" --request POST | jq -r .token | pbcopy

@fa[keyboard-o] curl Cheatsheet 2/3

  • curl http://localhost/api/v1/notes --request POST --header "Authorization: Bearer SNjmXWikniZZLaed8jDG5A==" --header "Content-Type: application/json" --data @Fixtures/request_create_note.json

@fa[keyboard-o] curl Cheatsheet 3/3

  • curl http://localhost/api/v1/notes/search --request POST --header "Authorization: Bearer FPG1Llqfl5Ju200ZDPb/ig==" --header "Content-Type: application/json" --data @Fixtures/request_search.json

---?code=Fixtures/request_create_note.json&title=JSON for creating notes&lang=json

---?code=Fixtures/response_files.json&title=Typical JSON response&lang=json

@fa[comments] Links

@fa[graduation-cap] Good luck!