Skip to content

Migration to APIs.guru domain #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
5 tasks done
IvanGoncharov opened this issue Jun 9, 2016 · 4 comments
Closed
5 tasks done

Migration to APIs.guru domain #85

IvanGoncharov opened this issue Jun 9, 2016 · 4 comments

Comments

@IvanGoncharov
Copy link
Member

IvanGoncharov commented Jun 9, 2016

TL;DR If you using our API please change https://apis-guru.github.io/api-models/api/v1/list.json to https://api.apis.guru/v2/list.json

We plan to move APIs.guru out of the proof-of-concept stage. Also, we want to improve our visibility in search engines and GitHub search. This involves some breaking changes to better organize URLs/repos and give them meaningful names (api-models R.I.P. 😢). So if you search for something like "Swagger API catalog" you should get APIs.guru at the first page.

 As part of this effort, we are moving all our resources to the APIs.guru domain (we will continue using GitHub pages under the hood).

Here is our migration plan:

  • Provide the copy of resources on APIs.guru domain;
  • Contact all potential API users on Twitter, Gitter, email, etc;
  • Old URLs will be removed on 22th Jun 29th Jun. If you need more time to do migration, please, comment on this issue;
  • 404 page with migration instructions on it;
  • Add Google Analytics to 404 page to track invalid requests and sites from which they are originated;

On 22th Jun all links to apis-guru.github.io will be automatically redirected to apis.guru.
Here is the table of breaking chages which helps you to easily migrate URLs:

Name Deprecated URL New URL
API apis-guru.github.io/api-models/api/v1/ api.apis.guru/v2/
Specs apis-guru.github.io/api-models/ api.apis.guru/v2/specs/
Badges apis-guru.github.io/api-models/banners/*_banners.svg api.apis.guru/badges/*.svg
Branding assets apis-guru.github.io/api-models/branding/ apis.guru/branding/

All other URLs from apis-guru.github.io will be automatically redirected but we still recommend you to rebase them on apis.guru

@IvanGoncharov
Copy link
Member Author

We tried GitHub Pages + CloudFlare combo to serve API on api.apis.guru domain.
But create a lot of problems since CloudFlare build for hosting websites and block "suspicious" traffic.
Especially if it coming from headless browsers like PhantomJS.

So we decided to try S3 for API hosting and so far it looks good.
I will run few experiments with it on https://s3.amazonaws.com/api.apis.guru/v2/list.json
And if everything will work I will switch it to be the official backend for api.apis.guru.

@IvanGoncharov
Copy link
Member Author

We setup new domain using S3 + CloudFront but we still need to setup custom SSL certificate in order to host it under api.apis.guru. It will take us couple mode days that mean we can't do migration today so we postpone it for one more week until 29th of June.

@IvanGoncharov
Copy link
Member Author

We switched to the new backend so starting from now we have everything nicely hosted on AWS with our own SSL certificate.

@IvanGoncharov
Copy link
Member Author

Few PRs is still open but we need to move forward and we will shut down old API on 8th Jul.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant