Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alca259/markdowndocumentation
Console tool for generate markdown documentation at .NET projects
https://github.com/alca259/markdowndocumentation
Last synced: about 1 month ago
JSON representation
Console tool for generate markdown documentation at .NET projects
- Host: GitHub
- URL: https://github.com/alca259/markdowndocumentation
- Owner: alca259
- License: apache-2.0
- Created: 2023-01-28T18:15:52.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-30T20:03:25.000Z (almost 2 years ago)
- Last Synced: 2023-09-13T20:53:19.180Z (over 1 year ago)
- Language: C#
- Size: 55.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MarkdownDocumentation
Console tool for generate markdown documentation at .NET projects
# Etiquetas soportadas:
- Propiedades y campos:
- `Resumen` _(Solo 1)_
- `` _(Solo 1)_
- Eventos .NET:
- `Resumen` _(Solo 1)_
- Clases, structs, interfaces (Tipos):
- `Resumen` _(Solo 1)_
- `Descripción` _(Solo 1)_
- Métodos:
- `Resumen` _(Solo 1)_
- `Resumen` _(Múltiples, se asume que en el mismo orden que se han definido en el método.)_
- `Descripción` _(Solo 1)_
- `Descripción` _(Múltiples)_
- `Resumen` _(Solo 1)_
- `Información de lo que se espera recibir, bien en formato JSON de los valores requeridos u otros.` _(Solo 1)_
- `Resumen de cuando se produce` _(Múltiples)_
- `Url relativa de la API` _(Solo 1)_ _(Solo para endpoints)_
- `` _(Múltiples)_ No admite resumen. Indica que se debe poseer uno de los permisos de este listado
# Ejemplo de documentar un endpoint:
```xml
Este es el resumen del endpoint
Esta es la descripción detallada de qué es lo que hace este endpoint
Filtros a aplicar en la petición
Token de cancelación provisto por .NET Core
Si el endpoint ha ido correctamente.
No autenticado
No autorizado
Error de servidor
/api/myapi/myendpoint
{
"FilterA": "some text",
"FilterB": 3,
"FiltersC": [
"FilterD": { "Text": "a.." }
]
}
Datos devueltos en caso de que todo vaya correctamente.
```
```csharp
[HttpPost, Route("api/myapi/myendpoint")]
[Authorize(Permission = MyPermissions.Web.PermissionA)]
[Authorize(Permission = MyPermissions.Web.PermissionB)]
[ProducesResponseType(typeof(MyEndpointOutputDto), (int)HttpStatusCode.OK)]
[ProducesResponseType((int)HttpStatusCode.Unauthorized)]
[ProducesResponseType((int)HttpStatusCode.Forbidden)]
[ProducesResponseType((int)HttpStatusCode.InternalServerError)]
public async Task GetDataFromMyEndpoint([FromBody] MyEndpointFiltersDto filters, CancellationToken cancellationToken = default)
```