11

I'm writing a REST API in PHP and I can't find any resources explaining how to work with OPTIONS. It seems to be an important part of REST API's, that's about how much I've found.

Can anyone explain what OPTIONS should contain and how it should be formatted?

Thanks in advance.

Karl Laurentius Roos
  • 4,360
  • 1
  • 33
  • 42

2 Answers2

13

The HTTP OPTIONS method returns (at least) the HTTP methods that the server supports for a specific URL. Per example, if you have a resource (/user) where you can create, retrieve and retrieve headers (but not delete or update), OPTIONS should return the following response header:

Allow: GET,HEAD,POST

If you can delete the resource as well, it would be:

Allow: GET,HEAD,POST,DELETE

You get the idea.

netcoder
  • 66,435
  • 19
  • 125
  • 142
5

See "OPTIONS" section 9.3.7 https://www.rfc-editor.org/rfc/rfc9110.html#name-options

Baskman
  • 75
  • 9
bcosca
  • 17,371
  • 5
  • 40
  • 51