Route Formats in v5

[hugoaboud]

I'm building an API that must be compatible (for now) with some of our legacy API standards, such as the .json suffix on CRUD routes.

I've found the legacy solution, however I wasn't able to find it on v5 neither on the discussions/issues.
What is the recommended way to approach that on the new version?

[anthrogan]

Route.get('/', () => {
  /** JSON response */
  return { page: 'home' }
})

or

Route.get('/', ({ response }) => {
  response.json(someObj)
})

or

Route.get('/', ({ response }) => {
  response.send({ foo: 'bar' })
})

https://docs.adonisjs.com/guides/response#sending-the-response

[hugoaboud]

Thank you for the quick reply. However your solution relates to the response type, which I understand is what the .json is supposed to do (and was probably removed due to this information being sent on the Content-Type header).
My problem lies on the fact that, given this route:

Route.get('/test', () => {
  return { page: 'test' }
});

I'm not able to access it through GET /test.json, only through GET /test.
I should also be able to access endpoints with an id such as GET /test/:id through GET /test/3.json for example.

I know this is and old/bad standard, however for compatibility reasons I must implement it for now.

[anthrogan]

Oh I see,

If you are using something like /test/data which returns a web page for example aswell as /test/data.json which returns json I guess though could use param maching

https://docs.adonisjs.com/guides/routing#params-matchers

You could even group your routes by .json response for example

Route.group( // your routes in here ).where('id', /W*(.json)\W*/gm)

So when a .json request is caught it runs specific end points

Edit: And for specific return all end points just make GET /test/alldata.json and it will match

[hugoaboud]

Thank you! The regex solved it very elegantly.

Here's my full solution:

• Routes with parameter: match optional '.json' with regex and remove it on cast.
• Routes without parameter: make a duplicate

const id_cast = { match: /^\d+(.json)?$/, cast: (id) => Number(id.replace('.json','')) };

Route.group(() => {
    Route.post("/", this.name+".create");
    Route.get("/", this.name+".index");
    Route.get("/:id", this.name+".read");
    Route.put("/:id", this.name+".update");
    Route.delete("/:id", this.name+".delete");
}).prefix(endpoint).middleware('auth').where('id', id_cast);

Route.post("/"+endpoint+'.json', this.name+".create").middleware('auth');
Route.get("/"+endpoint+'.json', this.name+".index").middleware('auth');

(Apparently I'm not able to mark your latest reply as the topic answer, only the original one. What do you suggest?)

[anthrogan]

Makes way more sense now that I can see how you have used id_cast 😂 glad we've found a work around!

[RomainLanz]

Hey @hugoaboud! 👋

You can still use the Content Negotiation. Simply create a middleware that set the Accept header depending on the URL received.

/example.json => "Accept: application/json"
/example => "Accept: text/html"

[Kuzzy]

@RomainLanz But there are no methods to set or modify request headers https://docs.adonisjs.com/guides/request

[Kuzzy]

It can be done like request.request.headers.accept = 'text/csv' But would it be better to add appropriate method(s) on request object?