REST interface, server for GET,PUT,POST,DELETE

Hi @Noah Aas , thanks a lot for your additional information. PosMan and SoapUI are used to test API, which playing the role of the client, while our API is playing the role of the server. Client APP getting/modifying data stored in server via API. When we don't have a client APP, we can use these tools to help test our API.

Then when we want to create an API project including REST interface, we can use VS template to save our time. Right click at the Controllers folder -> Add -> Controller -> choose API Controller with read/write actions. Then we will get a controller containing Get/Post/Put/Delete actions. Normally speaking, for CRUD actions, we need a Get request to list all items, and another Get request for displaying a specific item. Using Post Request to add a new item, a Put Request to update a specific item. Using Delete request to delete a specific item.

[Route("api/[controller]")]
[ApiController]
public class HelloController : ControllerBase
{
    // GET: api/<HelloController>
    [HttpGet]
    public IEnumerable<string> Get()
    {
        return new string[] { "value1", "value2" };
    }
    // GET api/<HelloController>/5
    [HttpGet("{id}")]
    public string Get(int id)
    {
        return "value";
    }
    // POST api/<HelloController>
    [HttpPost]
    public void Post([FromBody] string value)
    {
    }
    // PUT api/<HelloController>/5
    [HttpPut("{id}")]
    public void Put(int id, [FromBody] string value)
    {
    }
    // DELETE api/<HelloController>/5
    [HttpDelete("{id}")]
    public void Delete(int id)
    {
    }
}

Adding required business logic into the above template to realize your requirement.

Then let's see your concerns about the port. By default, there will have several options for running the app via VS, we could switch the type we want to run the app. For example, if I run the app via https like the screenshot below, the port shall be 7068, but if I choose IIS Express, the port will be 44380.

In the meantime, when we create an API project it already integrated Swagger into the app, so that when we run the application, we will have Swagger UI by default which already provide with us an interface to test the APIs defining in the project.

Thank you, it does not work.

I can create a template with the wizard. GET, PUT etc. are integrated. I start it, it does not work. I don't understand Swagger, when do I need it?

Should I now create http, https IIS Express or whatever. Swagger must work?

It is so difficult, incomprehensible everything.

Do you have another tip for me?

Can I create a VS application with several projects?

Client and server?

Hi , this is my test. I created a new API project via VS 2022, then I use VS template to create a controller containing Get/Post/Put/Delete actions. Right click at the Controllers folder -> Add -> Controller -> choose API Controller with read/write actions. Then I added builder.Services.AddControllers().AddXmlDataContractSerializerFormatters(); into Program.cs to make the API project support XML. then I added codes I shared above into the Controller generated just now, but to avoid conflict routes, I use [HttpPost("postXml")] instead of the origin [HttpPost]. Then pressing F5 to run the app, you will see your browser to list all the API endpoints containing in your API project, then you can test the API in this page.

I'm not sure what is your ultimate goal and what you is trapping you now. Swagger is a built in feature when we create an API project which is used for API testing.

Hello, Thanks a lot!

Maybe it's security settings from my company.
Could you upload your project to a cloud for download. With a description of how you created it and what you changed. I would be happy and thank you in advance.

Hi @Noah Aas ， just using VS 2022 to create a new .net 8 web API project, and open Program.cs to add builder.Services.AddControllers().AddXmlDataContractSerializerFormatters(); line within other builder.Services.xxxx. Then right click at the Controllers folder -> Add -> Controller -> choose API Controller with read/write actions to create a new Controller file, within this file, add a new method like codes below. Then running the application by pressing F5, then you will find a Browser opened and it's showing Swagger UI where you can test your APIs. You will find the REST interfaces you defined in your new Controller along with the postXml endpoint.

[HttpPost("postXml")]
public IActionResult Post([FromBody] XElement request) { 
// Define the response based on some logic or input request 
	XElement response = new XElement("Response", 
		new XElement("Data", "Answer"), 
		new XElement("Error", new XAttribute("code", "0"), 
		new XAttribute("description", "No power")) 
	); 
	return Content(response.ToString(), "application/xml"); 
}

I trust you will find all the endpoints can be called successfully. Then in the same application, you can then add codes below into the same controller which is used to call you api by C# codes. Don't forget to change the url. Here's all my testing process.

[HttpGet]
public async Task GetAsync() {
    string xmlData = @"<Request><Data>Hello, World!</Data></Request>";
    // The URL to send the POST request to (update with your local server URL)
    string url = "https://localhost:7051/api/hello";
    // Create a new HttpClient instance
    using (HttpClient client = new HttpClient())
    {
        // Set the content type to XML
        HttpContent content = new StringContent(xmlData, Encoding.UTF8, "application/xml");
        // Send the POST request
        HttpResponseMessage response = await client.PostAsync(url, content);
        // Ensure the response was successful, or throw an exception
        response.EnsureSuccessStatusCode();
        // Read the response content
        string responseContent = await response.Content.ReadAsStringAsync();
        // Print the response
        Console.WriteLine(responseContent);
    }
}