index : static-web-server.git

0957a11ff69d3d8b57e77001bcf6ca4281f9314b [patch]

a1a9b58b43e67f1e7cd648904cd550b24732c9d8

781ba91a76eea3b20873014203074dbcc683d31a

0957a11ff69d3d8b57e77001bcf6ca4281f9314b.tar.gz

docs: http methods supported [skip ci]

Diff

 docs/content/features/http-methods.md | 44 ++++++++++++++++++++++++++++++++++++-
 docs/mkdocs.yml                       |  1 +-
 2 files changed, 45 insertions(+)

diff --git a/docs/content/features/http-methods.md b/docs/content/features/http-methods.md
new file mode 100644
index 0000000..02ab44b
--- /dev/null
+++ b/docs/content/features/http-methods.md
@@ -0,0 +1,44 @@
# HTTP Methods Supported

**`SWS`** only supports [`GET`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET), [`HEAD`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) and [`OPTIONS`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS) HTTP methods.

## OPTIONS Method

### Identifying allowed request methods

The HTTP [OPTIONS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS) method can be used to send a request to check for permitted communication options for either a given URL or server.

Example using an HTTP client.

```sh
curl -I -X OPTIONS http://localhost:8787/assets/main.js
# HTTP/1.1 204 No Content
# allow: OPTIONS, HEAD, GET
# accept-ranges: bytes
# cache-control: public, max-age=31536000
# date: Thu, 10 Mar 2022 21:26:01 GMT
```

### Preflighted requests in CORS

The HTTP [OPTIONS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS) method can also be used to send a request asking if it is acceptable to send requests to the server and if it is aware of using specific methods and headers.

!!! info "Tip"
    If an `Access-Control-Request-Method` or `Access-Control-Request-Headers` value is not allowed then the server replies with a `403 Forbidden` HTTP error. See [CORS](./../cors/) feature for more details.

Example using an HTTP client.

```sh
curl http://localhost:8787/assets/main.js \
    -I -X OPTIONS \
    -H "Access-Control-Request-Method: HEAD" \
    -H "Access-Control-Request-Headers: content-type" \
    -H "Origin: http://localhost:8787"
# HTTP/1.1 204 No Content
# access-control-allow-origin: http://localhost:8787
# accept-ranges: bytes
# access-control-allow-headers: content-type, origin
# access-control-allow-methods: GET, OPTIONS, HEAD
# cache-control: public, max-age=31536000
# date: Thu, 10 Mar 2022 21:45:55 GMT
```
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 42f768a..48d6a56 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -120,6 +120,7 @@ nav:
    - 'Environment Variables': 'configuration/environment-variables.md'
  - 'Features':
    - 'HTTP/1': 'features/http1.md'
    - 'HTTP Methods': 'features/http-methods.md'
    - 'HTTP/2 and TLS': 'features/http2-tls.md'
    - 'Logging': 'features/logging.md'
    - 'Compression': 'features/compression.md'