ardalis / ardalis/ApiEndpoints

Add sample / improve docs when starting with an empty web api project

Open
#206 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
3.2k
Forks
232
PR merge metrics
No merged PRs in 30d

Description

Related to #202

The "getting started" section explains how to implement a handler. And the samples show how to work with the library in larger projects. But I wasn't able to find any documentation for the following case:

- Create an **empty** web api project
- The generated Program.cs contains

```cs
var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

// Remove the following minimal api line
// app.MapGet("/", () => "Hello World!");

app.Run();
```

At least I don't know what is required to register a handler. If you let me know I could work on a PR to improve the docs :)

Contributor guide

Open the contributing guide

Research direction

Start with the getting started section and existing samples, then compare them with the empty project’s generated Program.cs shown in the issue. Document how to register a handler in that setup and ensure the getting-started guidance covers the empty Web API case.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.