Web Development

Swagger Generated URL Questtion

8-May-24 21:32

You'll probably want to start with the documentation:
Bundler: gemfile[^]

"These people looked deep within my soul and assigned me a number based on the order in which I joined."
- Homer

Kevin Marois26-Apr-24 12:37

26-Apr-24 12:37

I have an Asp.Net MVC API with this controller :

namespace ApiDemo.Controllers
{
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class UsersController : ControllerBase
    {
        [HttpGet("{id}/{name}/{birthDate}/{isAlive}/{presNo}")]
        public IActionResult Get(int id, string name, DateTime birthDate, bool isAlive, int presNo)
        {
            return StatusCode(200);
        }
    }
}

When I call this Swagger generates this Request URL:

https:// localhost:7062/api/Users/Get/12345/Rutherford%20Birchard%20Hayes%20/1822-10-04%205%3A13%3A22/false/19

I don't understand the instances of '%20B' or '%3A22'. They are not always the same. What are these? Where are they coming from?

In theory, theory and practice are the same. But in practice, they never are.”
If it's not broken, fix it until it is.
Everything makes sense in someone's mind.

Dave Kreskowiak26-Apr-24 12:55

Dave Kreskowiak

26-Apr-24 12:55

It's %20, not %20B. The %20 is an encoded space character.

The same is true for %3A, not %3A22. The %3A is a colon.

Encoding is required because certain characters are illegal in URLs, like a space or :, unless specified in certain places. For example, a colon is only legal after the protocol and between the hostname and port number.

So, your unencoded URL is:

https://localhost:7062/api/Users/Get/12345/Rutherford Birchard Hayes /1822-10-04 5:13:22/false/19

Asking questions is a skill
CodeProject Forum Guidelines
Google: C# How to debug code
Seriously, go read these articles.
Dave Kreskowiak

Kevin Marois26-Apr-24 13:37

26-Apr-24 13:37

OK, so here's another from the same api call:

https:// localhost:7062/api/Users/Get/123/Jack%20Jones/1985-04-16%2012%3A34%3A56/true/16

So how would a client like, say for example a console app, call this? Would the app have to format the URL to convert spaces & colons to look like that??

Thanks!

In theory, theory and practice are the same. But in practice, they never are.”
If it's not broken, fix it until it is.
Everything makes sense in someone's mind.

Dave Kreskowiak26-Apr-24 14:13

Dave Kreskowiak

26-Apr-24 14:13

Yes! If you're going to use URLs, no matter what type of app you're writing, you must obey the rules of URLs!

WebUtility.UrlEncode(String) Method (System.Net) | Microsoft Learn[^]

Asking questions is a skill
CodeProject Forum Guidelines
Google: C# How to debug code
Seriously, go read these articles.
Dave Kreskowiak

Kevin Marois26-Apr-24 14:17

ASP.Net MVC Core API Question Revisited

26-Apr-24 14:17

Thanks!

In theory, theory and practice are the same. But in practice, they never are.”
If it's not broken, fix it until it is.
Everything makes sense in someone's mind.

Kevin Marois18-Apr-24 19:44

18-Apr-24 19:44

I posted on this yesterday, but I haven't made any progress.

I'm just trying to set up a simplet test API. Here's my controller:

[Route("api/user")]
[ApiController]
public class UserController : _ControllerBase
{
    public UserController(IConfiguration configuration) :
        base(configuration)
    {
    }

    [HttpGet("getById/{id}")]
    public IActionResult GetById([FromQuery]int id)
    {
        try
        {
            var repo = new Repository(GetDataContext());

            var owner = repo.GetById(id);

            if (owner is null)
            {
                return NotFound();
            }
            else
            {
                return Ok(owner);
            }
        }
        catch (Exception ex)
        {
            return StatusCode(500, "Internal server error");
        }
    }

    [HttpGet]
    public IActionResult GetAll()
    {
        try
        {
            var repo = new Repository(GetDataContext());

            var owners = repo.GetAll();

            return Ok(owners);
        }
        catch (Exception ex)
        {
            return StatusCode(500, "Internal server error");
        }
    }

    [HttpPost]
    public IActionResult Test([FromBody]TestEntity testEntity)
    {
        return StatusCode(200);
    }
}

I can call the first two methods, GetAll and GetById like this:

https: //localhost:5001/api/User
and
https: //localhost:5001/api/User/GetById/1

and they both return data. But this gives me a Not Found error

[HttpPost]
public IActionResult Test([FromBody]TestEntity testEntity)
{
//...
}

called using Postman like this:

https: //localhost:5001/api/User/test/{"id": 10,"name": Someone Else}

Questions
First, I'm not even sure I have the controller methods set up right. I don't really understand when/why to use the various attributes such as [FromBody] & [FromQuery]. I'm slowly learning by I may have it wrong here.

If I'm passing an object, as opposed to say an int, what should the method signature look like? Do I use FromBody or FromQuery? My Google searches return many different results. What would the correct syntax look like?

Second, the way I'm passing params, seperated by '/' seems wrong. Shouldn't the call to the API look something like this?

https: //localhost:2001/api/User/GetById?id=123

Am I doing something wrong here?

In theory, theory and practice are the same. But in practice, they never are.”
If it's not broken, fix it until it is.
Everything makes sense in someone's mind.

Richard Deeming18-Apr-24 21:27

18-Apr-24 21:27

Kevin Marois wrote:
called using Postman like this:
https://localhost:5001/api/User/test/{"id": 10,"name": Someone Else}

Aside from the syntax error in your JSON (no quotes around the name value), that doesn't look like a valid POST request to me.

In Postman, the method should be set to POST, and the JSON should be in the body, not the URL.

Send parameters and body data with API requests in Postman | Postman Learning Center[^]

"These people looked deep within my soul and assigned me a number based on the order in which I joined."
- Homer

Kevin Marois19-Apr-24 4:20

19-Apr-24 4:20

OK, but do I have the method set up correctly?

In theory, theory and practice are the same. But in practice, they never are.”
If it's not broken, fix it until it is.
Everything makes sense in someone's mind.

Richard Deeming19-Apr-24 4:43

19-Apr-24 4:43

The method looks OK, although you shouldn't really need the [FromBody] attribute.

For ASP.NET Core:

Model Binding in ASP.NET Core | Microsoft Learn[^]:
Route data and query string values are used only for simple types.

If you're still using WebAPI 2 in .NET Framework:

Parameter Binding in ASP.NET Web API - ASP.NET 4.x | Microsoft Learn[^]:
To force Web API to read a simple type from the request body, add the [FromBody] attribute to the parameter:

In either case, your parameter is not a "simple type", so it should be bound from the request body by default.

"These people looked deep within my soul and assigned me a number based on the order in which I joined."
- Homer

Kevin Marois19-Apr-24 5:19

19-Apr-24 5:19

OK, but even when I pass it in Postman from body, it still fails to find it. I'm not sure what's wrong

In theory, theory and practice are the same. But in practice, they never are.”
If it's not broken, fix it until it is.
Everything makes sense in someone's mind.

Kevin Marois21-Apr-24 12:22

21-Apr-24 12:22

OK, so I'm still having some issues.

I created a new API and enabled Swagger. I added this controller method to the default out of the box WeatherForecastController:

[HttpPost("GetPersonInfo/{entity}")]
public IActionResult GetPersonInfo(PersonEntity person)
{
    return StatusCode(200, $"{person.Id}: {person.Name}");
}

When I run it, and click the Try It Out button, I enter

{
  "id": 135,
  "name": "Jack Smith"
}

in the Body field and click Execute, and it works. I get back

135: Jack Smith

But when I go to Postman, and fill in the sample Json in the Body tab

{ "id": 135,  "name": "Jack Smith"}

and call it

https: //localhost:7160/api/WeatherForecast/GetPersonInfo

I get a 404.

That's the URL right out of swagger and the body I used. Any idea what this doesn't work in Postman?

In theory, theory and practice are the same. But in practice, they never are.”
If it's not broken, fix it until it is.
Everything makes sense in someone's mind.

modified 21-Apr-24 18:39pm.

Richard Deeming29-Apr-24 23:53

ASP.Net MVC Core API Question

29-Apr-24 23:53

Kevin Marois wrote:
[HttpPost("GetPersonInfo/{entity}")]

Assuming you're passing the JSON in the POST body, you shouldn't have the {entity} parameter as part of the route template.

Given the current route template, it looks like you're trying to pass the request body in the URL, which is the wrong thing to do.

"These people looked deep within my soul and assigned me a number based on the order in which I joined."
- Homer

Kevin Marois17-Apr-24 20:06

Re: ASP.Net MVC Core API Question

17-Apr-24 20:06

I'm trying to learn ASP.Net MVC Core API. I think I'm doing the routing wronge.

I have a UserController:

namespace Falcon.API.Controllers
{
    [Route("api/user")]
    [ApiController]
    public class UserController : _ControllerBase
    {
        public UserController(IConfiguration configuration) :
            base(configuration)
        {
        }

        [HttpGet("getById/{id}")]
        public IActionResult GetById(int id)
        {
            try
            {
                var repo = new Repository(GetDataContext());

                var owner = repo.GetById(id);

                if (owner is null)
                {
                    return NotFound();
                }
                else
                {
                    return Ok(owner);
                }
            }
            catch (Exception ex)
            {
                return StatusCode(500, "Internal server error");
            }
        }

        [HttpGet]
        public IActionResult GetAll()
        {
            try
            {
                var repo = new Repository(GetDataContext());

                var owners = repo.GetAll();

                return Ok(owners);
            }
            catch (Exception ex)
            {
                return StatusCode(500, "Internal server error");
            }
        }

        [HttpGet("login/{username}/{password}")]
        public IActionResult Login(string userName, string password)
        {
            try
            {
                var repo = new UserRepository(GetDataContext());

                var owner = repo.Login(userName, password);

                if (owner is null)
                {
                    return NotFound();
                }
                else
                {
                    return Ok(owner);
                }
            }
            catch (Exception ex)
            {
                return StatusCode(500, "Internal server error");
            }
        }
    }
}

When I call it, I'm doing this:

public async Task Login(string userName, string password)
{
    UserEntity results = null;

    var url = $"https:// localhost:5001/api/User/Login/{userName}/{password}";

    using (var httpClient = new HttpClient())
    {
        using (var response = await httpClient.GetAsync(url))
        {
            string apiResponse = await response.Content.ReadAsStringAsync();
            results = JsonConvert.DeserializeObject(apiResponse);
        }
    }

    return results;
}

This works. It calls the GetAll

https: //localhost:5001/api/User

This works when calling GetById

https: //localhost:5001/api/User/GetById/1

This does NOT work. I get a not found

https: //localhost:5001/api/User/Login/jsmith/mypass

Can someone tell me what's wrong?

In theory, theory and practice are the same. But in practice, they never are.”
If it's not broken, fix it until it is.
Everything makes sense in someone's mind.

Pete O'Hanlon17-Apr-24 20:34

Pete O'Hanlon

17-Apr-24 20:34

When you step through the Login code, what happens? The problem has to lie inside your repo.Login method, so that's the place you should be looking.

Advanced TypeScript Programming Projects

Re: ASP.Net MVC Core API Question

Kevin Marois18-Apr-24 11:54

Re: ASP.Net MVC Core API Question

18-Apr-24 11:54

I guess what I'm asking is - isn't this the wrong way to pass params?

var url = $"https:// localhost:5001/api/User/Login/{userName}/{password}";

If so, that means I've set something up incorrectly. But I don't really know what.

In theory, theory and practice are the same. But in practice, they never are.”
If it's not broken, fix it until it is.
Everything makes sense in someone's mind.

Richard Deeming18-Apr-24 0:06