example_custom_endpoint.yaml 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. # To include an endpoint that isn't a part of your Laravel app (or belongs to a vendor package),
  2. # you can define it in a custom.* YAML file, like this one. Here's an example:
  3. #- methods:
  4. # - POST
  5. # uri: api/doSomething/{param}
  6. # metadata:
  7. # groupName: The group the endpoint belongs to. Can be a new group or an existing group.
  8. # groupDescription: A description for the group. You don't need to set this for every endpoint; once is enough.
  9. # title: 'Do something.'
  10. # description: 'This endpoint allows you to do something.'
  11. # authenticated: false
  12. # headers:
  13. # Content-Type: application/json
  14. # Accept: application/json
  15. # urlParameters:
  16. # param:
  17. # name: param
  18. # description: A URL param for no reason.
  19. # required: true
  20. # example: 2
  21. # type: integer
  22. # queryParameters:
  23. # speed:
  24. # name: speed
  25. # description: How fast the thing should be done. Can be `slow` or `fast`.
  26. # required: false
  27. # example: fast
  28. # type: string
  29. # bodyParameters:
  30. # something:
  31. # name: something
  32. # description: The things we should do.
  33. # required: true
  34. # example:
  35. # - string 1
  36. # - string 2
  37. # type: 'string[]'
  38. # responses:
  39. # - status: 200
  40. # description: 'When the thing was done smoothly.'
  41. # content: # Your response content can be an object, an array, a string or empty.
  42. # {
  43. # "hey": "ho ho ho"
  44. # }
  45. # responseFields:
  46. # hey:
  47. # name: hey
  48. # description: Who knows?
  49. # type: string # This is optional