ASP.NET Core WEB API Problem with GET parameters in API method

Question

I have this controller

[ApiController]
    [Route("api/[controller]")]
    public class FamiliesController : ControllerBase
    {
        readonly FamilyFinanceContext db;
        public FamiliesController(FamilyFinanceContext context)
        {
            db = context;
        }


        [HttpDelete("deletefamily")]
        public async Task<ActionResult<Family>> DeleteFamilly(int id)
        {
            Family user = db.Families.FirstOrDefault(x => x.Id == id);
            if (user == null)
            {
                return NotFound();
            }
            db.Families.Remove(user);
            await db.SaveChangesAsync();
            return Ok(user);
        }
    }

after call https://localhost:44373/api/families/deletefamily?id=2 i have this error - HTTP ERROR 405 In theory this GET parameters must work. What i done not correctly?

You're asking for a DELETE ([HttpDelete("deletefamily")]) not a GET. Do you need to support both? — ESG
– ESG, Commented Feb 7, 2020 at 22:09
how do you calling this API? I think the problem is on your client-side — AliReza Sabouri
– AliReza Sabouri, Commented Feb 7, 2020 at 22:10
if you are using a web browser such as Chrome to do the call, that will do a GET and your controller is expecting a DELETE — Jonathan Busuttil
– Jonathan Busuttil, Commented Feb 8, 2020 at 18:32

Bryan Lewis · Accepted Answer · 2020-02-07 22:59:02Z

0

As ESG stated, your trying to do a DELETE, so you need to use the DELETE verb, not the GET verb. You're getting a 405 Method Not Allowed for this reason (you cannot use GET on a DELETE action). You should use a tool like PostMan (https://www.postman.com/) to create your DELETE requests, since you can't really do it easily just in a browser.

To fall more in line with REST convention, you should consider changing your DELETE method slightly:

    [HttpDelete("{id}")]
    public async Task<ActionResult> DeleteFamily([FromRoute] int id)
    {
        Family user = db.Families.FirstOrDefault(x => x.Id == id);
        if (user == null)
        {
            return NotFound();
        }
        db.Families.Remove(user);
        await db.SaveChangesAsync();
        return NoContent();
    }

You would then call this as DELETE https://localhost:44373/api/families/2

By using the [HttpDelete("{id}"] attribute, your moving the id from the query string to the URI, which is more in line with REST convention (the URI represents an object). Query string parameters are more typically used for optional capabilities, such as filtering, sorting, etc and not the endpoint representing the object itself.

Typically DELETE actions do not return content, but that is up to you. If you really want to return the user object, then stick with Ok(user), but NoContent is more typical of the DELETE verb.

edited Feb 7, 2020 at 22:59

answered Feb 7, 2020 at 22:28

Bryan Lewis

6,0484 gold badges42 silver badges48 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

stjns Over a year ago

You should also use decorators for the parameters, in your case [FromRoute] int id, or if he leaves it as a query parameter [FromQuery] int id. Also, specifying the type of the parameter as in {id:long} is only necessary if you have routes that are otherwise the same except for the type, which, IMO, you really shouldn't be doing anyway.

Bryan Lewis Over a year ago

@Bodacious, those are good points. I never really meant to have the type in there ("long") but I cut and pasted from some other code. I've updated the code.

Collectives™ on Stack Overflow

ASP.NET Core WEB API Problem with GET parameters in API method

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related