├── .gitignore ├── LICENSE ├── README.md ├── pom.xml └── src ├── main └── java │ └── com │ └── mindhaq │ └── apiversions │ ├── Application.java │ ├── domain │ ├── Address.java │ └── Hello.java │ ├── service │ └── AddressService.java │ └── web │ ├── AddressController.java │ ├── AddressParamV1.java │ ├── AddressParamV2.java │ └── HelloController.java └── test └── java └── com └── mindhaq └── apiversions └── integration ├── AddressIT.java └── HelloIT.java /.gitignore: -------------------------------------------------------------------------------- 1 | target/ 2 | pom.xml.tag 3 | pom.xml.releaseBackup 4 | pom.xml.next 5 | release.properties 6 | .idea 7 | restapi-versioning-spring.iml 8 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # restapi-versioning-spring 2 | 3 | How to implement the different approaches at REST API versioning with Spring MVC 4 | 5 | ## use case 6 | 7 | v1 of API requires address data as a single address parameter in the (german) format 8 | 9 | (five digit zip code)(one space character)(name of town) 10 | 11 | v2 changes that, requiring a (five digit) zip parameter and a (alphanumeric) town parameter. 12 | 13 | Sending data in a format not matching the used version should therefore result in a HTTP/1.1 400 14 | 15 | Also, getting the data will provide JSON data accordingly. 16 | 17 | Internal storage is considered to always have two fields. 18 | 19 | Additionally, there is one simple /hello resource available, which did not change between versions, but is available in both. 20 | 21 | ## resource definitions 22 | 23 | ### /address (version 1) 24 | 25 | GET /address 26 | { 27 | address: "10243 Berlin" 28 | } 29 | 30 | POST /address 31 | address=10243+Berlin 32 | 33 | ### /address (version 2) 34 | 35 | GET /address 36 | { 37 | zip: "10243", 38 | town: "Berlin" 39 | } 40 | 41 | POST /address 42 | zip=10243&town=Berlin 43 | 44 | ### /hello (version 1 and 2) 45 | 46 | GET /hello 47 | { 48 | hello: "world" 49 | } 50 | 51 | ## api detection approaches 52 | 53 | ### URL based: 54 | 55 | /apiurl/v1/address 56 | 57 | versus 58 | 59 | /apiurl/v2/address 60 | 61 | ### Custom HTTP header: 62 | 63 | /apiheader/address 64 | 65 | with 66 | 67 | X-API-Version: 1.0 68 | 69 | versus 70 | 71 | X-API-Version: 2.0 72 | 73 | ### Accept header with vendor and version 74 | 75 | /apiaccept/address 76 | 77 | with 78 | 79 | Accept: application/vnd.company.app-v1+json 80 | 81 | versus 82 | 83 | Accept: application/vnd.company.app-v2+json 84 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | com.mindhaq 7 | restapi-versioning-spring 8 | 1.0-SNAPSHOT 9 | 10 | 11 | org.springframework.boot 12 | spring-boot-starter-parent 13 | 1.1.5.RELEASE 14 | 15 | 16 | 17 | org.springframework.boot 18 | spring-boot-starter-web 19 | 20 | 21 | org.springframework.boot 22 | spring-boot-starter-test 23 | 24 | 25 | com.jayway.jsonpath 26 | json-path 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /src/main/java/com/mindhaq/apiversions/Application.java: -------------------------------------------------------------------------------- 1 | package com.mindhaq.apiversions; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.EnableAutoConfiguration; 5 | 6 | import org.springframework.context.annotation.ComponentScan; 7 | import org.springframework.context.annotation.Configuration; 8 | 9 | @Configuration 10 | @EnableAutoConfiguration 11 | @ComponentScan 12 | public class Application { 13 | public static void main(final String[] args) { 14 | SpringApplication.run(Application.class, args); 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /src/main/java/com/mindhaq/apiversions/domain/Address.java: -------------------------------------------------------------------------------- 1 | package com.mindhaq.apiversions.domain; 2 | 3 | public class Address { 4 | 5 | private final String zip; 6 | 7 | private final String town; 8 | 9 | public Address(final String zip, final String town) { 10 | this.zip = zip; 11 | this.town = town; 12 | } 13 | 14 | public String getZip() { 15 | return zip; 16 | } 17 | 18 | public String getTown() { 19 | return town; 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /src/main/java/com/mindhaq/apiversions/domain/Hello.java: -------------------------------------------------------------------------------- 1 | package com.mindhaq.apiversions.domain; 2 | 3 | public class Hello { 4 | public String getHello() { 5 | return "world"; 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/main/java/com/mindhaq/apiversions/service/AddressService.java: -------------------------------------------------------------------------------- 1 | package com.mindhaq.apiversions.service; 2 | 3 | import org.springframework.stereotype.Service; 4 | 5 | import com.mindhaq.apiversions.domain.Address; 6 | 7 | @Service 8 | public class AddressService { 9 | 10 | private Address address; 11 | 12 | public Address load() { 13 | return address; 14 | } 15 | 16 | public void save(final Address address) { 17 | this.address = address; 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/com/mindhaq/apiversions/web/AddressController.java: -------------------------------------------------------------------------------- 1 | package com.mindhaq.apiversions.web; 2 | 3 | import static org.springframework.http.HttpStatus.ACCEPTED; 4 | import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE; 5 | 6 | import static org.springframework.web.bind.annotation.RequestMethod.GET; 7 | import static org.springframework.web.bind.annotation.RequestMethod.POST; 8 | 9 | import java.util.regex.Matcher; 10 | import java.util.regex.Pattern; 11 | 12 | import javax.validation.Valid; 13 | 14 | import org.springframework.beans.factory.annotation.Autowired; 15 | 16 | import org.springframework.stereotype.Controller; 17 | 18 | import org.springframework.web.bind.annotation.ModelAttribute; 19 | import org.springframework.web.bind.annotation.RequestMapping; 20 | import org.springframework.web.bind.annotation.ResponseBody; 21 | import org.springframework.web.bind.annotation.ResponseStatus; 22 | 23 | import com.mindhaq.apiversions.domain.Address; 24 | import com.mindhaq.apiversions.service.AddressService; 25 | 26 | @Controller 27 | public class AddressController { 28 | 29 | @Autowired 30 | private AddressService addressService; 31 | 32 | @RequestMapping(value = "/apiurl/v1/address", method = GET, produces = APPLICATION_JSON_VALUE) 33 | @ResponseBody 34 | public AddressParamV1 getAddressUrlV1() { 35 | Address address = addressService.load(); 36 | return convertToV1(address); 37 | } 38 | 39 | @RequestMapping(value = "/apiurl/v2/address", method = GET, produces = APPLICATION_JSON_VALUE) 40 | @ResponseBody 41 | public AddressParamV2 getAddressUrlV2() { 42 | Address address = addressService.load(); 43 | return convertToV2(address); 44 | } 45 | 46 | @RequestMapping(value = "/apiurl/v1/address", method = POST) 47 | @ResponseBody 48 | @ResponseStatus(ACCEPTED) 49 | public void saveAddressUrlV1(@Valid @ModelAttribute final AddressParamV1 addressParamV1) { 50 | Address address = convertFromV1(addressParamV1); 51 | addressService.save(address); 52 | } 53 | 54 | @RequestMapping(value = "/apiurl/v2/address", method = POST) 55 | @ResponseStatus(ACCEPTED) 56 | public void saveAddressUrlV2(@Valid @ModelAttribute final AddressParamV2 addressParamV2) { 57 | Address address = convertFromV2(addressParamV2); 58 | addressService.save(address); 59 | } 60 | 61 | @RequestMapping( 62 | value = "/apiheader/address", method = GET, produces = APPLICATION_JSON_VALUE, headers = "X-API-Version=v1" 63 | ) 64 | @ResponseBody 65 | public AddressParamV1 getAddressHeaderV1() { 66 | Address address = addressService.load(); 67 | return convertToV1(address); 68 | } 69 | 70 | @RequestMapping( 71 | value = "/apiheader/address", method = GET, produces = APPLICATION_JSON_VALUE, headers = "X-API-Version=v2" 72 | ) 73 | @ResponseBody 74 | public AddressParamV2 getAddressHeaderV2() { 75 | Address address = addressService.load(); 76 | return convertToV2(address); 77 | } 78 | 79 | @RequestMapping(value = "/apiheader/address", method = POST, headers = "X-API-Version=v1") 80 | @ResponseStatus(ACCEPTED) 81 | public void saveAddressHeaderV1(@ModelAttribute @Valid final AddressParamV1 addressParamV1) { 82 | Address address = convertFromV1(addressParamV1); 83 | addressService.save(address); 84 | } 85 | 86 | @RequestMapping(value = "/apiheader/address", method = POST, headers = "X-API-Version=v2") 87 | @ResponseStatus(ACCEPTED) 88 | public void saveAddressHeaderV2(@ModelAttribute @Valid final AddressParamV2 addressParamV2) { 89 | Address address = convertFromV2(addressParamV2); 90 | addressService.save(address); 91 | } 92 | 93 | @RequestMapping(value = "/apiaccept/address", method = GET, produces = "application/vnd.company.app-v1+json") 94 | @ResponseBody 95 | public AddressParamV1 getAddressAcceptV1() { 96 | Address address = addressService.load(); 97 | return convertToV1(address); 98 | } 99 | 100 | @RequestMapping(value = "/apiaccept/address", method = GET, produces = "application/vnd.company.app-v2+json") 101 | @ResponseBody 102 | public AddressParamV2 getAddressAcceptV2() { 103 | Address address = addressService.load(); 104 | return convertToV2(address); 105 | } 106 | 107 | @RequestMapping(value = "/apiaccept/address", method = POST, headers = "Accept=application/vnd.company.app-v1+json") 108 | @ResponseStatus(ACCEPTED) 109 | public void saveAddressAcceptV1(@ModelAttribute @Valid final AddressParamV1 addressParamV1) { 110 | Address address = convertFromV1(addressParamV1); 111 | addressService.save(address); 112 | } 113 | 114 | @RequestMapping(value = "/apiaccept/address", method = POST, headers = "Accept=application/vnd.company.app-v2+json") 115 | @ResponseStatus(ACCEPTED) 116 | public void saveAddressAcceptV2(@ModelAttribute @Valid final AddressParamV2 addressParamV2) { 117 | Address address = convertFromV2(addressParamV2); 118 | addressService.save(address); 119 | } 120 | 121 | private AddressParamV1 convertToV1(final Address address) { 122 | AddressParamV1 addressParamV1 = new AddressParamV1(); 123 | addressParamV1.setAddress(address.getZip() + ' ' + address.getTown()); 124 | return addressParamV1; 125 | } 126 | 127 | private AddressParamV2 convertToV2(final Address address) { 128 | AddressParamV2 addressParamV2 = new AddressParamV2(); 129 | addressParamV2.setZip(address.getZip()); 130 | addressParamV2.setTown(address.getTown()); 131 | return addressParamV2; 132 | } 133 | 134 | private Address convertFromV1(final AddressParamV1 addressParamV1) { 135 | final String zip, town; 136 | 137 | Pattern p = Pattern.compile("(\\d{5}) (.*)"); 138 | Matcher m = p.matcher(addressParamV1.getAddress()); 139 | if (!m.matches()) { 140 | throw new IllegalArgumentException("unparsable address " + addressParamV1.getAddress()); 141 | } 142 | 143 | zip = m.group(1); 144 | town = m.group(2); 145 | return new Address(zip, town); 146 | } 147 | 148 | private Address convertFromV2(final AddressParamV2 addressParamV2) { 149 | return new Address(addressParamV2.getZip(), addressParamV2.getTown()); 150 | } 151 | } 152 | -------------------------------------------------------------------------------- /src/main/java/com/mindhaq/apiversions/web/AddressParamV1.java: -------------------------------------------------------------------------------- 1 | package com.mindhaq.apiversions.web; 2 | 3 | import javax.validation.constraints.Pattern; 4 | 5 | public class AddressParamV1 { 6 | 7 | private String address; 8 | 9 | @Pattern(regexp = "(\\d{5}) (.*)") 10 | public String getAddress() { 11 | return address; 12 | } 13 | 14 | public void setAddress(final String address) { 15 | this.address = address; 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /src/main/java/com/mindhaq/apiversions/web/AddressParamV2.java: -------------------------------------------------------------------------------- 1 | package com.mindhaq.apiversions.web; 2 | 3 | public class AddressParamV2 { 4 | 5 | private String zip; 6 | 7 | private String town; 8 | 9 | public String getZip() { 10 | return zip; 11 | } 12 | 13 | public void setZip(final String zip) { 14 | this.zip = zip; 15 | } 16 | 17 | public String getTown() { 18 | return town; 19 | } 20 | 21 | public void setTown(final String town) { 22 | this.town = town; 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /src/main/java/com/mindhaq/apiversions/web/HelloController.java: -------------------------------------------------------------------------------- 1 | package com.mindhaq.apiversions.web; 2 | 3 | import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE; 4 | 5 | import static org.springframework.web.bind.annotation.RequestMethod.GET; 6 | 7 | import org.springframework.stereotype.Controller; 8 | 9 | import org.springframework.web.bind.annotation.PathVariable; 10 | import org.springframework.web.bind.annotation.RequestHeader; 11 | import org.springframework.web.bind.annotation.RequestMapping; 12 | import org.springframework.web.bind.annotation.ResponseBody; 13 | 14 | import com.mindhaq.apiversions.domain.Hello; 15 | 16 | @Controller 17 | public class HelloController { 18 | 19 | private enum ValidVersion { 20 | v1, 21 | v2 22 | } 23 | 24 | @ResponseBody 25 | @RequestMapping(value = "/apiurl/{version}/hello", method = GET, produces = APPLICATION_JSON_VALUE) 26 | public Hello sayHelloWorldUrl(@PathVariable final ValidVersion version) { 27 | return new Hello(); 28 | } 29 | 30 | @ResponseBody 31 | @RequestMapping(value = "/apiheader/hello", method = GET, produces = APPLICATION_JSON_VALUE) 32 | public Hello sayHelloWorldHeader(@RequestHeader("X-API-Version") final ValidVersion version) { 33 | return new Hello(); 34 | } 35 | 36 | @ResponseBody 37 | @RequestMapping( 38 | value = "/apiaccept/hello", method = GET, 39 | produces = {"application/vnd.company.app-v1+json", "application/vnd.company.app-v2+json"} 40 | ) 41 | public Hello sayHelloWorldAccept() { 42 | return new Hello(); 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /src/test/java/com/mindhaq/apiversions/integration/AddressIT.java: -------------------------------------------------------------------------------- 1 | package com.mindhaq.apiversions.integration; 2 | 3 | import static org.hamcrest.Matchers.is; 4 | 5 | import static org.springframework.http.MediaType.APPLICATION_JSON; 6 | 7 | import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; 8 | import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; 9 | import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content; 10 | import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; 11 | import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; 12 | import static org.springframework.test.web.servlet.setup.MockMvcBuilders.webAppContextSetup; 13 | 14 | import org.junit.Before; 15 | import org.junit.Test; 16 | 17 | import org.junit.runner.RunWith; 18 | 19 | import org.springframework.beans.factory.annotation.Autowired; 20 | 21 | import org.springframework.boot.test.IntegrationTest; 22 | import org.springframework.boot.test.SpringApplicationConfiguration; 23 | 24 | import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; 25 | import org.springframework.test.context.web.WebAppConfiguration; 26 | import org.springframework.test.web.servlet.MockMvc; 27 | import org.springframework.test.web.servlet.ResultMatcher; 28 | 29 | import org.springframework.web.context.WebApplicationContext; 30 | 31 | import com.mindhaq.apiversions.Application; 32 | import com.mindhaq.apiversions.domain.Address; 33 | import com.mindhaq.apiversions.service.AddressService; 34 | 35 | @RunWith(SpringJUnit4ClassRunner.class) 36 | @SpringApplicationConfiguration(classes = Application.class) 37 | @WebAppConfiguration 38 | @IntegrationTest 39 | public class AddressIT { 40 | 41 | @Autowired 42 | private WebApplicationContext wac; 43 | 44 | private MockMvc mockMvc; 45 | 46 | @Autowired 47 | private AddressService addressService; 48 | 49 | @Before 50 | public void initMockMvc() { 51 | this.mockMvc = webAppContextSetup(wac).build(); 52 | } 53 | 54 | @Before 55 | public void prepareTestData() { 56 | Address address = new Address("12043", "Berlin"); 57 | addressService.save(address); 58 | } 59 | 60 | /* ------------------------------------------------------------------- */ 61 | 62 | @Test 63 | public void should_respond_with_address_json_on_v1_url() throws Exception { 64 | mockMvc.perform(get("/apiurl/v1/address").accept(APPLICATION_JSON)) // 65 | .andExpect(status().isOk()) // 66 | .andExpect(jsonContent()) // 67 | .andExpect(jsonPath("$.address", is("12043 Berlin"))); 68 | } 69 | 70 | @Test 71 | public void should_respond_with_address_json_on_v2_url() throws Exception { 72 | mockMvc.perform(get("/apiurl/v2/address").accept(APPLICATION_JSON)) // 73 | .andExpect(status().isOk()) // 74 | .andExpect(jsonContent()) // 75 | .andExpect(jsonPath("$.zip", is("12043"))) // 76 | .andExpect(jsonPath("$.town", is("Berlin"))); 77 | } 78 | 79 | @Test 80 | public void should_respond_with_404_on_v3_url() throws Exception { 81 | mockMvc.perform(get("/apiurl/v3/address").accept(APPLICATION_JSON)) // 82 | .andExpect(status().isNotFound()); 83 | } 84 | 85 | @Test 86 | public void should_respond_with_created_on_v1_url() throws Exception { 87 | mockMvc.perform(post("/apiurl/v1/address").param("address", "12055 Berlin")) // 88 | .andExpect(status().isAccepted()); 89 | } 90 | 91 | @Test 92 | public void should_respond_with_created_on_v2_url() throws Exception { 93 | mockMvc.perform(post("/apiurl/v2/address").param("zip", "12055").param("town", "Berlin")) // 94 | .andExpect(status().isAccepted()); 95 | } 96 | 97 | /* ------------------------------------------------------------------- */ 98 | 99 | @Test 100 | public void should_respond_with_hello_json_with_v1_header() throws Exception { 101 | mockMvc.perform(get("/apiheader/address").accept(APPLICATION_JSON).header("X-API-Version", "v1")) // 102 | .andExpect(status().isOk()) // 103 | .andExpect(jsonContent()) // 104 | .andExpect(jsonPath("$.address", is("12043 Berlin"))); 105 | } 106 | 107 | @Test 108 | public void should_respond_with_hello_json_with_v2_header() throws Exception { 109 | mockMvc.perform(get("/apiheader/address").accept(APPLICATION_JSON).header("X-API-Version", "v2")) // 110 | .andExpect(status().isOk()) // 111 | .andExpect(jsonContent()) // 112 | .andExpect(jsonPath("$.zip", is("12043"))) // 113 | .andExpect(jsonPath("$.town", is("Berlin"))); 114 | } 115 | 116 | @Test 117 | public void should_respond_with_bad_request_with_v3_header() throws Exception { 118 | mockMvc.perform(get("/apiheader/address").accept(APPLICATION_JSON).header("X-API-Version", "v3")) // 119 | .andExpect(status().isNotFound()); 120 | } 121 | 122 | @Test 123 | public void should_respond_with_bad_request_without_version_header() throws Exception { 124 | mockMvc.perform(get("/apiheader/address").accept(APPLICATION_JSON)) // 125 | .andExpect(status().isNotFound()); 126 | } 127 | 128 | @Test 129 | public void should_respond_with_created_with_v1_header() throws Exception { 130 | mockMvc.perform(post("/apiheader/address") // 131 | .header("X-API-Version", "v1") // 132 | .param("address", "12055 Berlin")) // 133 | .andExpect(status().isAccepted()); // 134 | } 135 | 136 | @Test 137 | public void should_respond_with_created_with_v2_header() throws Exception { 138 | mockMvc.perform( 139 | post("/apiheader/address") // 140 | .header("X-API-Version", "v2") // 141 | .param("zip", "12055") // 142 | .param("town", "Berlin")) // 143 | .andExpect(status().isAccepted()); // 144 | } 145 | 146 | /* ------------------------------------------------------------------- */ 147 | 148 | @Test 149 | public void should_respond_with_hello_json_with_v1_accept() throws Exception { 150 | mockMvc.perform(get("/apiaccept/address").accept("application/vnd.company.app-v1+json")) // 151 | .andExpect(status().isOk()) // 152 | .andExpect(content().contentType("application/vnd.company.app-v1+json")) // 153 | .andExpect(jsonPath("$.address", is("12043 Berlin"))); 154 | } 155 | 156 | @Test 157 | public void should_respond_with_hello_json_with_v2_accept() throws Exception { 158 | mockMvc.perform(get("/apiaccept/address").accept("application/vnd.company.app-v2+json")) // 159 | .andExpect(status().isOk()) // 160 | .andExpect(content().contentType("application/vnd.company.app-v2+json")) // 161 | .andExpect(jsonPath("$.zip", is("12043"))) // 162 | .andExpect(jsonPath("$.town", is("Berlin"))); 163 | } 164 | 165 | @Test 166 | public void should_respond_with_not_acceptable_with_v3_accept() throws Exception { 167 | mockMvc.perform(get("/apiaccept/address").accept("application/vnd.company.app-v3+json")) // 168 | .andExpect(status().isNotAcceptable()); 169 | } 170 | 171 | @Test 172 | public void should_respond_with_created_with_v1_accept() throws Exception { 173 | mockMvc.perform( 174 | post("/apiaccept/address") // 175 | .accept("application/vnd.company.app-v1+json") // 176 | .param("address", "12055 Berlin")) // 177 | .andExpect(status().isAccepted()); // 178 | } 179 | 180 | @Test 181 | public void should_respond_with_created_with_v2_accept() throws Exception { 182 | mockMvc.perform( 183 | post("/apiaccept/address") // 184 | .accept("application/vnd.company.app-v2+json") // 185 | .param("zip", "12055") // 186 | .param("town", "Berlin")) // 187 | .andExpect(status().isAccepted()); // 188 | } 189 | 190 | private ResultMatcher jsonContent() { 191 | return content().contentType(APPLICATION_JSON); 192 | } 193 | } 194 | -------------------------------------------------------------------------------- /src/test/java/com/mindhaq/apiversions/integration/HelloIT.java: -------------------------------------------------------------------------------- 1 | package com.mindhaq.apiversions.integration; 2 | 3 | import static org.hamcrest.Matchers.is; 4 | 5 | import static org.springframework.http.MediaType.APPLICATION_JSON; 6 | 7 | import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; 8 | import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content; 9 | import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; 10 | import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; 11 | import static org.springframework.test.web.servlet.setup.MockMvcBuilders.webAppContextSetup; 12 | 13 | import org.junit.Before; 14 | import org.junit.Test; 15 | 16 | import org.junit.runner.RunWith; 17 | 18 | import org.springframework.beans.factory.annotation.Autowired; 19 | 20 | import org.springframework.boot.test.IntegrationTest; 21 | import org.springframework.boot.test.SpringApplicationConfiguration; 22 | 23 | import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; 24 | import org.springframework.test.context.web.WebAppConfiguration; 25 | import org.springframework.test.web.servlet.MockMvc; 26 | 27 | import org.springframework.web.context.WebApplicationContext; 28 | 29 | import com.mindhaq.apiversions.Application; 30 | 31 | @RunWith(SpringJUnit4ClassRunner.class) 32 | @SpringApplicationConfiguration(classes = Application.class) 33 | @WebAppConfiguration 34 | @IntegrationTest 35 | public class HelloIT { 36 | 37 | @Autowired 38 | private WebApplicationContext wac; 39 | 40 | private MockMvc mockMvc; 41 | 42 | @Before 43 | public void initMockMvc() { 44 | this.mockMvc = webAppContextSetup(wac).build(); 45 | } 46 | 47 | @Test 48 | public void should_respond_with_hello_json_on_v1_url() throws Exception { 49 | mockMvc.perform(get("/apiurl/v1/hello").accept(APPLICATION_JSON)) // 50 | .andExpect(status().isOk()) // 51 | .andExpect(content().contentType(APPLICATION_JSON)) // 52 | .andExpect(jsonPath("$.hello", is("world"))); 53 | } 54 | 55 | @Test 56 | public void should_respond_with_hello_json_on_v2_url() throws Exception { 57 | mockMvc.perform(get("/apiurl/v2/hello").accept(APPLICATION_JSON)) // 58 | .andExpect(status().isOk()) // 59 | .andExpect(content().contentType(APPLICATION_JSON)) // 60 | .andExpect(jsonPath("$.hello", is("world"))); 61 | } 62 | 63 | @Test 64 | public void should_respond_with_400_on_v3_url() throws Exception { 65 | mockMvc.perform(get("/apiurl/v3/hello").accept(APPLICATION_JSON)) // 66 | .andExpect(status().isBadRequest()); 67 | } 68 | 69 | /* ------------------------------------------------------------------- */ 70 | 71 | @Test 72 | public void should_respond_with_hello_json_with_v1_header() throws Exception { 73 | mockMvc.perform(get("/apiheader/hello").accept(APPLICATION_JSON).header("X-API-Version", "v1")) // 74 | .andExpect(status().isOk()) // 75 | .andExpect(content().contentType(APPLICATION_JSON)) // 76 | .andExpect(jsonPath("$.hello", is("world"))); 77 | } 78 | 79 | @Test 80 | public void should_respond_with_hello_json_with_v2_header() throws Exception { 81 | mockMvc.perform(get("/apiheader/hello").accept(APPLICATION_JSON).header("X-API-Version", "v2")) // 82 | .andExpect(status().isOk()) // 83 | .andExpect(content().contentType(APPLICATION_JSON)) // 84 | .andExpect(jsonPath("$.hello", is("world"))); 85 | } 86 | 87 | @Test 88 | public void should_respond_with_bad_request_with_v3_header() throws Exception { 89 | mockMvc.perform(get("/apiheader/hello").accept(APPLICATION_JSON).header("X-API-Version", "v3")) // 90 | .andExpect(status().isBadRequest()); 91 | } 92 | 93 | @Test 94 | public void should_respond_with_bad_request_without_version_header() throws Exception { 95 | mockMvc.perform(get("/apiheader/hello").accept(APPLICATION_JSON)) // 96 | .andExpect(status().isBadRequest()); 97 | } 98 | 99 | /* ------------------------------------------------------------------- */ 100 | 101 | @Test 102 | public void should_respond_with_hello_json_with_v1_accept() throws Exception { 103 | mockMvc.perform(get("/apiaccept/hello").accept("application/vnd.company.app-v1+json")) // 104 | .andExpect(status().isOk()) // 105 | .andExpect(content().contentType("application/vnd.company.app-v1+json")) // 106 | .andExpect(jsonPath("$.hello", is("world"))); 107 | } 108 | 109 | @Test 110 | public void should_respond_with_hello_json_with_v2_accept() throws Exception { 111 | mockMvc.perform(get("/apiaccept/hello").accept("application/vnd.company.app-v2+json")) // 112 | .andExpect(status().isOk()) // 113 | .andExpect(content().contentType("application/vnd.company.app-v2+json")) // 114 | .andExpect(jsonPath("$.hello", is("world"))); 115 | } 116 | 117 | @Test 118 | public void should_respond_with_not_acceptable_with_v3_accept() throws Exception { 119 | mockMvc.perform(get("/apiaccept/hello").accept("application/vnd.company.app-v3+json")) // 120 | .andExpect(status().isNotAcceptable()); 121 | } 122 | 123 | } 124 | --------------------------------------------------------------------------------