Remove configurable 'prefix' + change the non-configurable prefix from '/api' to '/jsonapi'

@Wim Leers

Thanks for brining this up. This change feels necessary to make the api more accessible to outside/first time users. I am +1 on changing the prefix to jsonapi from api. I would however prefer /{entity type}/{bundle}/{uuid} with an Accept header, but I understand that it may not be currently feasible due to a bunch of outside issues.

I like the idea to change the default prefix to /jsonapi rather /api. But I still feel the need to keep it as a config value, to be able to change it if someone want to use something more custom / project related. The this will come back at core when the module hit Experimental State.

+1 for changing the prefix from 'api' to 'jsonapi' And yes, having the "Accept" header work would be wonderful.

@killua99

I'm not totally opposed to having this as a config value. However keeping it fixed will provide a more consistent experience for users of a JSON-API based API across a number of different Drupal sites.

@killua99 @drpal I, too, like the idea of removing the option to change the prefix. Using the /jsonapi URL prefix follows Drupal best-practices of using the module's name as the prefix for its custom routes, so collisions will hopefully be minimal. And, if someone really needs to change the route prefix on a particular site, it is possible to alter existing routes.

I got the OK from e0ipso on IRC to move ahead with #9: removing config and changing the URL prefix to /jsonapi.

This looks very good; the hard-coded prefix makes route names much cleaner! Two small issues found in review:
1. The README.md file still refers to URLs with the /api prefix
2. jsonapi/tests/src/Unit/Context/CurrentContextTest.php:71 uses a route for '/api/articles' in its tests. Not sure fi this makes any difference, but may want to change that to use something like /jsonapi/node/article.

Once those are fixed, I think this can be RTBC.

Ugh, sorry for the extraneous comments :P

I did a quick review and all looks good. So much easier when you get stuff RTBCed :_)

This is merged.

This change requires an update at the docs: https://www.drupal.org/node/2804085

I think would be nice to document how to change the prefix like Wim indicated in #17.

Documentation updated! It might make sense to refactor the documentation and remove the page at https://www.drupal.org/node/2804085 completely, or reuse it to give a detailed example of altering the routes.

It's worth noting that you can detect if a route is managed by JSON API by checking:

$route->getOption('_is_jsonapi');

I tryied the following implementation change the URL prefix and works fine:

namespace Drupal\custom_example\Routing;

use Drupal\Core\Routing\RouteSubscriberBase;
use Symfony\Component\Routing\RouteCollection;

/**
 * Listens to the dynamic route events.
 */
class CustomRouteSubscriber extends RouteSubscriberBase {

  /**
   * {@inheritdoc}
   */
  protected function alterRoutes(RouteCollection $collection) {

    $routesCollection = $collection->all();
    foreach ($routesCollection as $key => $route) {
      if ($route->getOption('_is_jsonapi')) {
        $path = $route->getPath();
        $newPath = str_replace('/jsonapi', '/api/v1', $path);
        $route->setPath($newPath);
      }
    }
  }
}

any suggestion is welcome.

@ #29 This works for the collection/list request, but breaks for individual item request. i.e. /api/v1/node/11 will return a 404 instead of the node with id 11

Note that JSON API nowadays has a jsonapi.base_path container parameter.

I too wanted to replace /jsonapi with /api/v1, and all it took was this in my service provider:

namespace Drupal\bojan_test;

use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\DependencyInjection\ServiceProviderBase;

class BojanTestServiceProvider extends ServiceProviderBase {

  /**
   * {@inheritdoc}
   */
  public function alter(ContainerBuilder $container) {
    $container->setParameter('jsonapi.base_path', '/api/v1');
  }

}

(This issue is ranked high in a Google search, so I figured I'd leave a note)