README
¶
#Casimiro A basic template for REST servers in golang created for personal use.
There is a lot of stuff to be done yet, check [TODO.md] (https://github.com/acorsinl/casimiro/blob/master/TODO.md) for further information.
#Setup ##server.go ###Constants Two environment variables are needed, one for the HTTP listening port, one for the MySQL connection string. These two are set as constants so you can modify their name as preferred.
Casimiro is supposed to run behind an API manager or similar proxy tools, therefore it expects the user id to be given by the upper layer in a Header. Name of that header can be changed in UserHeader constant.
ResourcesUrl: For each resource Casimiro defines a new file with all the standard REST methods, hence more constants like this should be added for each resource your server will serve. Names for the urls are set here.
###Routing Just replace the variable names for your choice of preference.
##resources.go Just a basic template for the basic REST methods. SQL queries must be added, as well as extra validations needed for your business logic and extending/modifying the Resource struct.
#Licensing Casimiro is licensed under BSD 3 clause license. See [LICENSE] (https://github.com/acorsinl/casimiro/blob/master/LICENSE) for the full license text.
Documentation
¶
Overview ¶
Copyright (c) 2015, Alberto Corsín Lafuente All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Source Files
Directories