Helium


Source link: https://github.com/stanfy/helium

Helium

Helium is a DSL for REST API specifications and also a Java API for processing descriptions written in this language. The main goal of this project is to create a single source of truth about some REST API. Taking a spec as an input, Helium generates a lot of useful stuff that can be used to rapidly develop REST clients.

Specification Example

note "Twitter REST API example"  type "UserProfile" message {

id long required
screen_name 'string' required
profile_image_url_https 'string' optional 
}
  service {

name 'Twitter API'
description 'Piece of Twitter API'
version 1.1
 location "https://api.twitter.com/${
version
}
"
 get "/users/show.json" spec {

  name 'Get user profile'
  description ''' 

Returns a variety of information about the user specified by the required user_id 

or screen_name parameter. The author's most recent Tweet will be returned inline when possible. 
 '''
  parameters {

 user_id long optional

 screen_name 'string' optional

 include_entities boolean optional
  
}

  response "UserProfile"

}
 
}
 

Documentation

The main idea is to keep the single source of truth about data structures and contracts used in interactions via your REST API.

After writing a Helium spec you'll get automatically generated tests for described API and will be able to generate useful source code. Generated tests validate received responses to match data structures described in the spec.

On our wiki you'll find information about

Currently we support JSON, when generate API tests, and Java, when generate source code.

Both tests and code generation are implemented via Java API provided by Helium for processing specs. This API allows you to access all the types, services, and methods described in specification.

You may use Helium Java API directly from your Java code or utilize our Gradle plugin to integrate Helium spec with your Gradle project.

You can find an Android project integration sample in this repository.

Java API Examples

// read from string new Helium().from("service {
name 'Example Service'
}
").processBy(new Handler() {

public void process(Project p) {

  System.out.println(p.getServices());

}
 
}
);
  // read from file and generate POJOs new Helium().from(new File("twitter.spec"))
.processBy(new EntitiesGenerator(

 new File("/build/gen"),

 EntitiesGeneratorOptions.defaultOptions("com.example.twitter")
));

With Groovy :)

You can write the specification code directly in your client:

new Helium().from {

service {

  name 'Example service'

}
 
}
.processBy({
 Project p ->
println p.services 
}
 as Handler)

License

 Copyright 2013 Stanfy Corp.
Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.  You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software  distributed under the License is distributed on an "AS IS" BASIS,  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and  limitations under the License. 

Resources

There is a lovely method on the android.text.Html class, fromHtml(), that converts HTML into a Spannable for use with a TextView.

However, the documentation does not stipulate what HTML tags are supported, which makes this method a bit hit-or-miss. This small library provides a fluent API for building valid HTML for android.widget.TextView.

sandrios camera allows developers to integrate image and video capturing without dealing with the complicated camera APIs.

Take a screenshot of your view layout, programmatically!

Showcase application of SQLDelight and SQLBrite working together based on SQLBrite's sample.

It is a lightweight library which helps to create a custom view.

Nice and simple customizable implementation of Google style up/down arrow.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes