Service Export
Reported by Matt Todd | April 30th, 2008 @ 12:17 AM | in Release 0.6.0
It would be cool to be able to specify some methods to export
into a simple summary of available services to users wanting to know how to use the Halcyon app similar in concept to WSDL.
Sample usage could be:
app/messages.rb
class Messages < Application
export :create, :read
def create
# implementation
end
def read
# implementation
end
def update
# implementation
end
def delete
# implementation
end
end
This would indicate that only the create
and read
actions are described in this service description.
The service description could be queried at /services
or something similar.
Comments and changes to this ticket
-
Matt Todd April 30th, 2008 @ 12:19 AM
There could also be ways to extract out information and comments about what each method does, either straight from the source or by a method (such as
explain
used inside of an action).class Messages < Application export :create, :read def create explain "creates a new message to add to the queue" # implementation end # etc end
Please Sign in or create a free account to add a new ticket.
With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.