Changeset 37903

Timestamp:

06/29/2016 01:56:32 AM (7 years ago)

Author:

rachelbaker

Message:

REST API: Include auto-discovery Link header when serving API requests.

The Link header allows clients to verify if a site has made the REST API available, as well as indicating how to access it.

Props danielbachhuber.
Fixes #35580.

Location:

trunk

Files:

• src/wp-includes/rest-api/class-wp-rest-server.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-server.php (modified) (1 diff)

trunk/src/wp-includes/rest-api/class-wp-rest-server.php

@@ -228 +228 @@
         $this->send_header( 'Content-Type', $content_type . '; charset=' . get_option( 'blog_charset' ) );
         $this->send_header( 'X-Robots-Tag', 'noindex' );
+
+        $api_root = get_rest_url();
+        if ( ! empty( $api_root ) ) {
+            $this->send_header( 'Link', '<' . esc_url_raw( $api_root ) . '>; rel="https://api.w.org/"' );
+        }
 
         /*

trunk/tests/phpunit/tests/rest-api/rest-server.php

@@ -727 +727 @@
     }
 
+    public function test_link_header_on_requests() {
+        $api_root = get_rest_url();
+
+        $request = new WP_REST_Request( 'GET', '/', array() );
+
+        $result = $this->server->serve_request('/');
+        $headers = $this->server->sent_headers;
+
+        $this->assertEquals( '<' . esc_url_raw( $api_root ) . '>; rel="https://api.w.org/"', $headers['Link'] );
+    }
+
     public function test_nocache_headers_on_authenticated_requests() {
         $editor = self::factory()->user->create( array( 'role' => 'editor' ) );