# {py:mod}`labthings_fastapi.descriptors.endpoint`

```{py:module} labthings_fastapi.descriptors.endpoint
```

```{autodoc2-docstring} labthings_fastapi.descriptors.endpoint
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`EndpointDescriptor <labthings_fastapi.descriptors.endpoint.EndpointDescriptor>`
  - ```{autodoc2-docstring} labthings_fastapi.descriptors.endpoint.EndpointDescriptor
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`HTTPMethod <labthings_fastapi.descriptors.endpoint.HTTPMethod>`
  - ```{autodoc2-docstring} labthings_fastapi.descriptors.endpoint.HTTPMethod
    :summary:
    ```
````

### API

````{py:data} HTTPMethod
:canonical: labthings_fastapi.descriptors.endpoint.HTTPMethod
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.descriptors.endpoint.HTTPMethod
```

````

`````{py:class} EndpointDescriptor(func: typing.Callable, http_method: labthings_fastapi.descriptors.endpoint.HTTPMethod = 'get', path: typing.Optional[str] = None, **kwargs: typing.Mapping)
:canonical: labthings_fastapi.descriptors.endpoint.EndpointDescriptor

```{autodoc2-docstring} labthings_fastapi.descriptors.endpoint.EndpointDescriptor
```

````{py:method} __init__(func: typing.Callable, http_method: labthings_fastapi.descriptors.endpoint.HTTPMethod = 'get', path: typing.Optional[str] = None, **kwargs: typing.Mapping)
:canonical: labthings_fastapi.descriptors.endpoint.EndpointDescriptor.__init__

```{autodoc2-docstring} labthings_fastapi.descriptors.endpoint.EndpointDescriptor.__init__
```

````

````{py:method} __get__(obj: typing.Optional[labthings_fastapi.thing.Thing], type=None) -> typing.Union[typing_extensions.Self, typing.Callable]
:canonical: labthings_fastapi.descriptors.endpoint.EndpointDescriptor.__get__

```{autodoc2-docstring} labthings_fastapi.descriptors.endpoint.EndpointDescriptor.__get__
```

````

````{py:property} name
:canonical: labthings_fastapi.descriptors.endpoint.EndpointDescriptor.name

```{autodoc2-docstring} labthings_fastapi.descriptors.endpoint.EndpointDescriptor.name
```

````

````{py:property} path
:canonical: labthings_fastapi.descriptors.endpoint.EndpointDescriptor.path

```{autodoc2-docstring} labthings_fastapi.descriptors.endpoint.EndpointDescriptor.path
```

````

````{py:property} title
:canonical: labthings_fastapi.descriptors.endpoint.EndpointDescriptor.title

```{autodoc2-docstring} labthings_fastapi.descriptors.endpoint.EndpointDescriptor.title
```

````

````{py:property} description
:canonical: labthings_fastapi.descriptors.endpoint.EndpointDescriptor.description

```{autodoc2-docstring} labthings_fastapi.descriptors.endpoint.EndpointDescriptor.description
```

````

````{py:method} add_to_fastapi(app: fastapi.FastAPI, thing: labthings_fastapi.thing.Thing)
:canonical: labthings_fastapi.descriptors.endpoint.EndpointDescriptor.add_to_fastapi

```{autodoc2-docstring} labthings_fastapi.descriptors.endpoint.EndpointDescriptor.add_to_fastapi
```

````

`````