expected_service.api 838 B

123456789101112131415161718192021222324252627282930313233343536
  1. // server foo
  2. @server ( // server
  3. // key-value form
  4. key1: value1
  5. key2: value2
  6. jwt: Auth // enable jwt
  7. prefix: /v1 // the route prefix
  8. )
  9. // service foo
  10. service foo { // foo
  11. // example1
  12. @doc "example1"
  13. @handler example1 // handler declare
  14. get /path/example1 // no body
  15. @doc ( // doc group
  16. key1: "value1"
  17. key11: "value11"
  18. key111: "value111"
  19. )
  20. @handler example2 // handler example2
  21. get /path/example2/:id // path arg
  22. @doc "example3"
  23. @handler example3
  24. get /path/example3/:id (Foo) // no response
  25. @doc "example4"
  26. @handler example4
  27. post /path/example4/a-b returns (Foo) // no request
  28. @doc "example5"
  29. @handler example5
  30. // example5
  31. post /path/example5/a-b (Foo) returns (Bar) // do not comment between path and body
  32. }